Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
AccountBrands

Creates one or more brand profiles for an account.

This method creates one or more brand profile files for an account.

To specify logos for the brand, use the AccountBrands: updateLogo method after you create the brand.

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

  • canSelfBrandSign
  • canSelfBrandSend

Related topics

  • How to create a brand
post/v2.1/accounts/{accountId}/brands

Path parameters

accountIdstring required

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

Request body

brandCompanystring

The name of the company associated with the brand.

brandIdstring

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

brandLanguagesstring[]

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.

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)
isOrganizationBrandstring
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.

organizationBrandLogostring

Response

Successful response.