This method updates an account brand.

Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Request

HTTP request

PUT /v2.1/accounts/{accountId}/brands/{brandId}

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

brandIdstring

The id of the brand.

Request Body

brand

Responses

CodeDescriptionReference
200

Successful response.

brand
400

Error encountered.

errorDetails

SDK Method

Accounts::updateBrand

Definitions

brand

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

brandCompanystring

The name of the company associated with the brand.

brandIdstring

The id of the brand.

brandLanguages[array]

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)

brandNamestring

The name of the brand.

colors[nameValue]

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

defaultBrandLanguagestring

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[brandEmailContent]

Deprecated.

errorDetailserrorDetails

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

isOverridingCompanyNameboolean

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

isSendingDefaultboolean

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

isSigningDefaultboolean

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

landingPages[nameValue]

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[brandLink]

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

logosbrandLogos

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

resourcesbrandResourceUrls

An object containing the URLs for the four DocuSign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience.

Note: This object is returned only when the resourceContentType is sending, signing, email, or signing_captive.

brandEmailContent

Deprecated.

contentstring

Deprecated.

emailContentTypestring

Deprecated.

emailToLinkstring

Deprecated.

linkTextstring

Deprecated.

Information about a link that a brand uses.

linkTextstring

The text used for the link.

linkTypestring

The type of link. Valid values include:

  • aboutDocusign
  • closeButton

showLinkstring

When true, the link displays to the recipient.

urlOrMailTostring

The URL or mailto address of the link.

brandLogos

Information about the logos associated with the brand.

emailstring

The URI for the logo that the brand uses in the header of email messages.

primarystring

The URI for the brand's primary logo.

secondarystring

The URI for the brand's secondary logo.

brandResourceUrls

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.

emailstring

The URI for the email resource file that the brand uses.

sendingstring

The URI for the sending resource file that the brand uses.

signingstring

The URI for the signing resource file that the brand uses.

signingCaptivestring

The URI for the captive (embedded) signing resource file that the brand uses.

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.

Examples

Generic JSON Request/Response

Request
{
  "brandCompany": "sample string 1",
  "brandId": "sample string 2",
  "brandName": "sample string 3",
  "colors": [
    {}
  ],
  "isOverridingCompanyName": "sample string 4",
  "isSendingDefault": "sample string 5",
  "isSigningDefault": "sample string 6",
  "landingPages": [
    {}
  ],
  "links": [
    {
      "linkType": "sample string 1",
      "urlOrMailTo": "sample string 2",
      "linkText": "sample string 3",
      "showLink": "sample string 4"
    }
  ],
  "emailContent": [
    {
      "emailContentType": "sample string 1",
      "content": "sample string 2",
      "emailToLink": "sample string 3",
      "linkText": "sample string 4"
    }
  ],
  "logos": {
    "primary": "sample string 1",
    "secondary": "sample string 2",
    "email": "sample string 3"
  },
  "resources": {
    "email": "sample string 1",
    "sending": "sample string 2",
    "signing": "sample string 3",
    "signingCaptive": "sample string 4"
  }
}
Response
{
  "brandCompany": "sample string 1",
  "brandId": "sample string 2",
  "brandName": "sample string 3",
  "colors": [
    {}
  ],
  "errorDetails": {
    "errorCode": "sample string 1",
    "message": "sample string 2"
  },
  "isOverridingCompanyName": "sample string 4",
  "isSendingDefault": "sample string 5",
  "isSigningDefault": "sample string 6",
  "landingPages": [
    {}
  ],
  "links": [
    {
      "linkType": "sample string 1",
      "urlOrMailTo": "sample string 2",
      "linkText": "sample string 3",
      "showLink": "sample string 4"
    }
  ],
  "emailContent": [
    {
      "emailContentType": "sample string 1",
      "content": "sample string 2",
      "emailToLink": "sample string 3",
      "linkText": "sample string 4"
    }
  ],
  "logos": {
    "primary": "sample string 1",
    "secondary": "sample string 2",
    "email": "sample string 3"
  },
  "resources": {
    "email": "sample string 1",
    "sending": "sample string 2",
    "signing": "sample string 3",
    "signingCaptive": "sample string 4"
  }
}
Generic XML Request/Response

Request
<brand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <brandCompany>sample string 1</brandCompany>
  <brandId>sample string 2</brandId>
  <brandName>sample string 3</brandName>
  <colors>
    <nameValue />
  </colors>
  <emailContent>
    <brandEmailContent>
      <content>sample string 2</content>
      <emailContentType>sample string 1</emailContentType>
      <emailToLink>sample string 3</emailToLink>
      <linkText>sample string 4</linkText>
    </brandEmailContent>
  </emailContent>
  <isOverridingCompanyName>sample string 4</isOverridingCompanyName>
  <isSendingDefault>sample string 5</isSendingDefault>
  <isSigningDefault>sample string 6</isSigningDefault>
  <landingPages>
    <nameValue />
  </landingPages>
  <links>
    <brandLink>
      <linkText>sample string 3</linkText>
      <linkType>sample string 1</linkType>
      <showLink>sample string 4</showLink>
      <urlOrMailTo>sample string 2</urlOrMailTo>
    </brandLink>
  </links>
  <logos>
    <email>sample string 3</email>
    <primary>sample string 1</primary>
    <secondary>sample string 2</secondary>
  </logos>
  <resources>
    <email>sample string 1</email>
    <sending>sample string 2</sending>
    <signing>sample string 3</signing>
    <signingCaptive>sample string 4</signingCaptive>
  </resources>
</brand> 
Response
<brand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <brandCompany>sample string 1</brandCompany>
  <brandId>sample string 2</brandId>
  <brandName>sample string 3</brandName>
  <colors>
    <nameValue />
  </colors>
  <emailContent>
    <brandEmailContent>
      <content>sample string 2</content>
      <emailContentType>sample string 1</emailContentType>
      <emailToLink>sample string 3</emailToLink>
      <linkText>sample string 4</linkText>
    </brandEmailContent>
  </emailContent>
  <errorDetails>
    <errorCode>sample string 1</errorCode>
    <message>sample string 2</message>
  </errorDetails>
  <isOverridingCompanyName>sample string 4</isOverridingCompanyName>
  <isSendingDefault>sample string 5</isSendingDefault>
  <isSigningDefault>sample string 6</isSigningDefault>
  <landingPages>
    <nameValue />
  </landingPages>
  <links>
    <brandLink>
      <linkText>sample string 3</linkText>
      <linkType>sample string 1</linkType>
      <showLink>sample string 4</showLink>
      <urlOrMailTo>sample string 2</urlOrMailTo>
    </brandLink>
  </links>
  <logos>
    <email>sample string 3</email>
    <primary>sample string 1</primary>
    <secondary>sample string 2</secondary>
  </logos>
  <resources>
    <email>sample string 1</email>
    <sending>sample string 2</sending>
    <signing>sample string 3</signing>
    <signingCaptive>sample string 4</signingCaptive>
  </resources>
</brand> 
}} />