Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Account Brands

Creates one or more brand profiles for an account

POST
/v2.1/accounts/{accountId}/brands

This method creates one or more brand profile files for an account.

To specify logos for the brand, use the AccountBrands: updateLogo method after you create the brand.

Either or both of the following settings must be enabled for the account to use this method:

  • canSelfBrandSign
  • canSelfBrandSend

Related topics

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

Request Body

application/json

Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.

brandCompany?string

The name of the company associated with the brand.

brandId?string

The ID used to identify a specific brand in API calls.

brandLanguages?array<string>

An array of two-letter codes for the languages that you want to use with the brand. The supported languages are:

  • Arabic (ar)
  • Armenian (hy)
  • Bahasa Indonesia (id)
  • Bahasa Malay (ms)
  • Bulgarian (bg)
  • Chinese Simplified (zh_CN)
  • Chinese Traditional (zh_TW)
  • Croatian (hr)
  • Czech (cs)
  • Danish (da)
  • Dutch (nl)
  • English UK (en_GB)
  • English US (en)
  • Estonian (et)
  • Farsi (fa)
  • Finnish (fi)
  • French (fr)
  • French Canada (fr_CA)
  • German (de)
  • Greek (el)
  • Hebrew (he)
  • Hindi (hi)
  • Hungarian (hu)
  • Italian (it)
  • Japanese (ja)
  • Korean (ko)
  • Latvian (lv)
  • Lithuanian (lt)
  • Norwegian (no)
  • Polish (pl)
  • Portuguese (pt)
  • Portuguese Brasil (pt_BR)
  • Romanian (ro)
  • Russian (ru)
  • Serbian (sr)
  • Slovak (sk)
  • Slovenian (sl)
  • Spanish (es)
  • Spanish Latin America (es_MX)
  • Swedish (sv)
  • Thai (th)
  • Turkish (tr)
  • Ukranian (uk)
  • Vietnamese (vi)
brandName?string

The name of the brand.

colors?array<>

An array of name-value pairs specifying the colors that the brand uses for the following elements:

  • Button background
  • Button text
  • Header background
  • Header text
defaultBrandLanguage?string

The two-letter code for the language that you want to use as the brand default. The supported languages are:

  • Arabic (ar)
  • Armenian (hy)
  • Bahasa Indonesia (id)
  • Bahasa Malay (ms)
  • Bulgarian (bg)
  • Chinese Simplified (zh_CN)
  • Chinese Traditional (zh_TW)
  • Croatian (hr)
  • Czech (cs)
  • Danish (da)
  • Dutch (nl)
  • English UK (en_GB)
  • English US (en)
  • Estonian (et)
  • Farsi (fa)
  • Finnish (fi)
  • French (fr)
  • French Canada (fr_CA)
  • German (de)
  • Greek (el)
  • Hebrew (he)
  • Hindi (hi)
  • Hungarian (hu)
  • Italian (it)
  • Japanese (ja)
  • Korean (ko)
  • Latvian (lv)
  • Lithuanian (lt)
  • Norwegian (no)
  • Polish (pl)
  • Portuguese (pt)
  • Portuguese Brasil (pt_BR)
  • Romanian (ro)
  • Russian (ru)
  • Serbian (sr)
  • Slovak (sk)
  • Slovenian (sl)
  • Spanish (es)
  • Spanish Latin America (es_MX)
  • Swedish (sv)
  • Thai (th)
  • Turkish (tr)
  • Ukranian (uk)
  • Vietnamese (vi)
emailContent?array<>

Deprecated.

errorDetails?

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

isOrganizationBrand?string
isOverridingCompanyName?boolean

When true, the brandCompany property is overriding the name of the company in the account settings.

isSendingDefault?boolean

When true, the sending brand is the default brand for sending new envelopes.

isSigningDefault?boolean

When true, the siging brand is the default brand for the signing experience.

landingPages?array<>

An array of name/value pairs specifying the pages to which the user is redirected after the following events occur:

  • Signing Completed
  • Viewed Exit
  • Finish Later
  • Decline
  • Session Timeout
  • Authentication Failure

If you do not specify landing pages, the Docusign default pages are used.

links?array<>

An array of brandLink objects that contain information about the links that the brand uses.

logoIds?
logos?

The URIs for retrieving the logos that are associated with the brand.

These are read-only properties that provide a URI to logos in use. To update a logo use AccountBrands: updateLogo.

organizationBrandLogo?string
resources?

Brands use resource files to style the following experiences:

  • Email
  • Sending
  • Signing
  • Captive (embedded) signing

You can modify these resource files to customize these experiences.

Response Body

application/json

application/json

curl -X POST "https://example.com/v2.1/accounts/string/brands" \  -H "Content-Type: application/json" \  -d '{}'
{  "brands": [    {      "brandCompany": "string",      "brandId": "string",      "brandLanguages": [        "string"      ],      "brandName": "string",      "colors": [        {          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "name": "string",          "originalValue": "string",          "value": "string"        }      ],      "defaultBrandLanguage": "string",      "emailContent": [        {          "content": "string",          "emailContentType": "string",          "emailToLink": "string",          "linkText": "string"        }      ],      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "isOrganizationBrand": "string",      "isOverridingCompanyName": true,      "isSendingDefault": true,      "isSigningDefault": true,      "landingPages": [        {          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "name": "string",          "originalValue": "string",          "value": "string"        }      ],      "links": [        {          "linkText": "string",          "linkType": "string",          "showLink": "string",          "urlOrMailTo": "string"        }      ],      "logoIds": {        "emailLogoId": "string",        "primaryLogoId": "string",        "secondaryLogoId": "string"      },      "logos": {        "email": "string",        "primary": "string",        "secondary": "string"      },      "organizationBrandLogo": "string",      "resources": {        "email": "string",        "sending": "string",        "signing": "string",        "signingCaptive": "string"      }    }  ],  "recipientBrandIdDefault": "string",  "senderBrandIdDefault": "string"}

Gets a list of brands GET

This method returns details about all of the [brands](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/branding/) associated with an account, including the default brand profiles. Either or both of the following settings must be enabled for the account to use this method: - `canSelfBrandSign` - `canSelfBrandSend` ### Related topics - [How to create a brand](https://developers.docusign.com/docs/esign-rest-api/how-to/create-brand/) - [How to apply a brand to an envelope](https://developers.docusign.com/docs/esign-rest-api/how-to/apply-brand-to-envelope/)

Deletes one or more brand profiles DELETE

This method deletes one or more brand profiles from an account, based on the brand IDs that you include in the `brandsRequest`. Either or both of the following settings must be enabled for the account to use this method: - `canSelfBrandSign` - `canSelfBrandSend` ### Related topics - [How to create a brand](https://developers.docusign.com/docs/esign-rest-api/how-to/create-brand/)