v1

latestSwagger 2.02026-07-134146194.6 MB

AccountBrands

Updates an existing brand.

This method updates 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).

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

Path parameters

accountIdstring required

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

brandIdstring required

The ID of the brand.

Query parameters

replace_brandstring

When true, replaces the brand instead of updating it. The only unchanged value is the brand ID. The request body must be XML. The default value is false.

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.