Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

brandIdstring

The unique identifier for a brand. This property is used to apply branding to an envelope.

Optional Query Parameters
include_external_referencesstring

include_logosstring

Responses

CodeDescriptionReference
200

Successful response.

brand
400

Error encountered.

errorDetails

SDK Method

Accounts::getBrand

Definitions

brand

brandCompanystring

The name of the company associated with this brand.

brandIdstring

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

brandLanguages[array]

An array of ISO 3166-1 alpha-2 country codes that specify the languages this brand supports.

brandNamestring

The name of the brand.

colors[nameValue]

defaultBrandLanguagestring

The ISO 3166-1 alpha-2 country code of this brand's default language.

emailContent[brandEmailContent]

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

isOverridingCompanyNameboolean

isSendingDefaultboolean

isSigningDefaultboolean

landingPages[nameValue]

links[brandLink]

logosbrandLogos

resourcesbrandResourceUrls

brandEmailContent

contentstring

emailContentTypestring

emailToLinkstring

linkTextstring

linkTextstring

linkTypestring

showLinkstring

urlOrMailTostring

brandLogos

emailstring

Filters returned user records by the specified email address.

primarystring

secondarystring

brandResourceUrls

emailstring

Filters returned user records by the specified email address.

sendingstring

signingstring

signingCaptivestring

errorDetails

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

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

nameValue

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

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.

Examples

Generic JSON Response

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 Response

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> 
}} />