Account Brands

Gets information about a brand

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

This method returns details about 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).

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.

brandId*string

The ID of the brand.

Query Parameters

include_external_references?string

When true, the landing pages and links associated with the brand are included in the response.

include_logos?string

When true, the URIs for the logos associated with the brand are included in the response.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/brands/string"
{  "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"  }}