Skip to content

DocuSign: Gets the supported languages for envelope recipients

DocuSign esignature.esignatureSupportedLanguagesGetSupportedLanguages: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_supportedlanguages_getsupportedlanguages

Provider route: GET /restapi/v2.1/accounts/{accountId}/supported_languages. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureSupportedLanguagesGetSupportedLanguages"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureSupportedLanguagesGetSupportedLanguages(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_supported_languages_get_supported_languages(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets the supported languages for envelope recipients — response body

Referenced models: Gets the supported languages for envelope recipients — response body

Gets the supported languages for envelope recipients — response body
FieldTypePresenceDescription and constraints
$objectRootA list of supported languages.
languagesarrayOptionalA list of languages that you can use for a recipient's language setting. These are the languages that you can set for the standard email format and signing view for each recipient.

For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience.

**Note:** Setting a language for a recipient affects only the Docusign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it.

Example:

```
{
"languages": [
{
"name": "Arabic (ar)",
"value": "ar"
},
{
"name": "Bulgarian (bg)",
"value": "bg"
},
.
.
.
}
```
languages[]ModelEach itemExpand Updates an existing brand — response body — colors item

Referenced models: Updates an existing brand — response body — colors item

Updates an existing brand — response body — colors item
FieldTypePresenceDescription and constraints
$objectRootA name-value pair that describes an item and provides a value for the item.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
namestringOptionalThe name of the item.
originalValuestringOptionalThe initial value of the item.
valuestringOptionalThe current value of the item.

Referenced models: Locks a template — response body — error Details

Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.

SDK function policy ID: docusign.esignature_supportedlanguages_getsupportedlanguages. Catalog operation: esignature:SupportedLanguages_GetSupportedLanguages. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.