Accounts: listSupportedLanguages

Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. 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.

For more information, see Set Recipient Language and Specify Custom Email Messages.

Request

HTTP request

GET /v2.1/accounts/{accountId}/supported_languages

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

Responses

CodeDescriptionReference
200

Successful response.

supportedLanguages
400

Error encountered.

errorDetails

SDK Method

Accounts::getSupportedLanguages

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

nameValue

A name-value pair that describes an item and provides a value for the item.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

namestring

The name of the item.

originalValuestring

The initial value of the item.

valuestring

The current value of the item.

supportedLanguages

A list of supported languages.

languages[nameValue]

A 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"
        },
        .
        .
        .
}

Examples

Generic JSON Response

Response
{
  "languages": [
    {}
  ]
}
Generic XML Response

Response
<supportedLanguages xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API_REST.Models.v2">
  <languages xmlns:d2p1="http://www.docusign.com/restapi">
    <d2p1:nameValue />
  </languages>
</supportedLanguages> 
}} />