Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties canSelfBrandSend and canSelfBrandSend) must be set to true for the account to use this call.

Request

HTTP request

GET /v2/accounts/{accountId}/brands

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Optional Query Parameters
exclude_distributor_brandstring

When set to true, excludes distributor brand information from the response set.

include_logosstring

When set to true, returns the logos associated with the brand.

Responses

CodeDescriptionReference
200

Successful response.

AccountBrands
400

Error encountered.

errorDetails

SDK Method

Accounts::listBrands

Definitions

brand

brandCompanystring

The name of the company associated with this brand.

brandIdstring

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

brandNamestring

The name of the brand.

colors[nameValue]

emailContent[brandEmailContent]

errorDetailserrorDetails

isOverridingCompanyNamestring

isSendingDefaultstring

isSigningDefaultstring

landingPages[nameValue]

links[brandLink]

logosbrandLogos

resourcesbrandResourceUrls

brandEmailContent

contentstring

emailContentTypestring

emailToLinkstring

linkTextstring

linkTextstring

linkTypestring

showLinkstring

urlOrMailTostring

brandLogos

emailstring

primarystring

secondarystring

brandResourceUrls

emailstring

sendingstring

signingstring

signingCaptivestring

errorDetails

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

errorCodestring

An error code associated with the error.

messagestring

A short error message.

nameValue

errorDetailserrorDetails

namestring

The name or key of a name/value pair.

originalValuestring

The initial value of the tab when it was sent to the recipient.

valuestring

The value field of a name/value pair.

AccountBrands

Brand management for accounts

brands[brand]

The list of brands.

recipientBrandIdDefaultstring

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

senderBrandIdDefaultstring

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

Examples

Generic JSON Response

Response
{
  "recipientBrandIdDefault": "sample string 1",
  "senderBrandIdDefault": "sample string 2",
  "brands": [
    {
      "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 Response

Response
<xml xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <brands>
    <brand>
      <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>
  </brands>
  <recipientBrandIdDefault>sample string 1</recipientBrandIdDefault>
  <senderBrandIdDefault>sample string 2</senderBrandIdDefault>
</xml> 
}} />