Create brand profiles

POST

/v2.1/accounts/:accountId/brands

POST

/restapi/v2.1/accounts/:accountId/brands

curl -X POST https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/brands \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "brandCompany": "sample string 1",
  "brandId": "sample string 2",
  "brandLanguages": [
    "sample string 1"
  ],
  "brandName": "sample string 3",
  "colors": [
    {
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "name": "sample string 1",
      "originalValue": "sample string 2",
      "value": "sample string 3"
    }
  ],
  "defaultBrandLanguage": "sample string 4",
  "emailContent": [
    {
      "content": "sample string 1",
      "emailContentType": "sample string 2",
      "emailToLink": "sample string 3",
      "linkText": "sample string 4"
    }
  ],
  "isOrganizationBrand": "sample string 5",
  "isOverridingCompanyName": true,
  "isSendingDefault": true,
  "isSigningDefault": true,
  "landingPages": [
    {}
  ],
  "links": [
    {
      "linkText": "sample string 1",
      "linkType": "sample string 2",
      "showLink": "sample string 3",
      "urlOrMailTo": "sample string 4"
    }
  ],
  "logoIds": {
    "emailLogoId": "sample string 1",
    "primaryLogoId": "sample string 2",
    "secondaryLogoId": "sample string 3"
  },
  "logos": {
    "email": "sample string 1",
    "primary": "sample string 2",
    "secondary": "sample string 3"
  },
  "organizationBrandLogo": "sample string 6",
  "resources": {
    "email": "sample string 1",
    "sending": "sample string 2",
    "signing": "sample string 3",
    "signingCaptive": "sample string 4"
  }
}'

{
  "brands": [
    {
      "brandCompany": "sample string 1",
      "brandId": "sample string 2",
      "brandLanguages": [
        "sample string 1"
      ],
      "brandName": "sample string 3",
      "colors": [
        {
          "errorDetails": {
            "errorCode": "sample string 1",
            "message": "sample string 2"
          },
          "name": "sample string 1",
          "originalValue": "sample string 2",
          "value": "sample string 3"
        }
      ],
      "defaultBrandLanguage": "sample string 4",
      "emailContent": [
        {
          "content": "sample string 1",
          "emailContentType": "sample string 2",
          "emailToLink": "sample string 3",
          "linkText": "sample string 4"
        }
      ],
      "isOrganizationBrand": "sample string 5",
      "isOverridingCompanyName": true,
      "isSendingDefault": true,
      "isSigningDefault": true,
      "landingPages": [
        {}
      ],
      "links": [
        {
          "linkText": "sample string 1",
          "linkType": "sample string 2",
          "showLink": "sample string 3",
          "urlOrMailTo": "sample string 4"
        }
      ],
      "logoIds": {
        "emailLogoId": "sample string 1",
        "primaryLogoId": "sample string 2",
        "secondaryLogoId": "sample string 3"
      },
      "logos": {
        "email": "sample string 1",
        "primary": "sample string 2",
        "secondary": "sample string 3"
      },
      "organizationBrandLogo": "sample string 6",
      "resources": {
        "email": "sample string 1",
        "sending": "sample string 2",
        "signing": "sample string 3",
        "signingCaptive": "sample string 4"
      }
    }
  ],
  "recipientBrandIdDefault": "sample string 1",
  "senderBrandIdDefault": "sample string 2"
}

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

How to create a brand

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

Request

This endpoint expects an object: brand

brandCompanystringOptional

The name of the company associated with the brand.

brandIdstringOptional

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

brandLanguageslist of stringsOptional

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)

brandNamestringOptional

The name of the brand.

colorslist of objectsOptional

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

defaultBrandLanguagestringOptional

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)

emailContentlist of objectsOptional

Deprecated.

errorDetailsobjectOptional

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

isOrganizationBrandstringOptional

isOverridingCompanyNamebooleanOptional

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

isSendingDefaultbooleanOptional

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

isSigningDefaultbooleanOptional

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

landingPageslist of objectsOptional

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.

linkslist of objectsOptional

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

logoIdsobjectOptional

logosobjectOptional

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.

organizationBrandLogostringOptional

resourcesobjectOptional

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

Successful response.

brandslist of objectsOptional

The list of brands.

recipientBrandIdDefaultstringOptional

The brand seen by envelope recipients when a brand is not explicitly set.

senderBrandIdDefaultstringOptional

The brand seen by envelope senders when a brand is not explicitly set.

Errors

400

Bad Request Error

Related topics

Authentication

Path parameters

Request

Response

Errors