Account Brands

Gets a list of brands

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

This method returns details about all of the brands associated with an account, including the default brand profiles.

Either or both of the following settings must be enabled for the account to use this method:

  • canSelfBrandSign
  • canSelfBrandSend

Related topics

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.

Query Parameters

exclude_distributor_brand?string

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

include_logos?string

When true, returns the logos associated with the brand.

Response Body

application/json

application/json

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