docusign.account-brands.put-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).

Updates an existing brand.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
brandid	string	Yes	—	The ID of the brand.
replace_brand	string	No	—	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.
brandcompany	string	No	—	The name of the company associated with the brand.
brandid_2	string	No	—	The ID used to identify a specific brand in API calls.
brandlanguages	list	No	—	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)
brandname	string	No	—	The name of the brand.
colors	list	No	—	An array of name-value pairs specifying the colors that the brand uses for the following elements: - Button background - Button text - Header background - Header text
defaultbrandlanguage	string	No	—	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)
emailcontent	list	No	—	Deprecated.
errordetails	json	No	—	This object describes errors that occur. It is only valid for responses and ignored in requests.
isorganizationbrand	string	No	—	—
isoverridingcompanyname	boolean	No	—	When true, the brandCompany property is overriding the name of the company in the account settings.
issendingdefault	boolean	No	—	When true, the sending brand is the default brand for sending new envelopes.
issigningdefault	boolean	No	—	When true, the siging brand is the default brand for the signing experience.
landingpages	list	No	—	An array of name/value pairs specifying the pages to which the user is redirected after the following events occur: - Signing Completed - Viewed Exit - Finish Later - Decline - Session Timeout - Authentication Failure If you do not specify landing pages, the Docusign default pages are used.
links	list	No	—	An array of brandLink objects that contain information about the links that the brand uses.
logoids	json	No	—	—
logos	json	No	—	The URIs for retrieving the logos that are associated with the brand. These are read-only properties that provide a URI to logos in use. To update a logo use AccountBrands: updateLogo.
organizationbrandlogo	string	No	—	—
resources	json	No	—	Brands use resource files to style the following experiences: - Email - Sending - Signing - Captive (embedded) signing You can modify these resource files to customize these experiences.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
brandid	string	Yes	—	The ID of the brand.
replace_brand	string	No	—	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.
brandcompany	string	No	—	The name of the company associated with the brand.
brandid_2	string	No	—	The ID used to identify a specific brand in API calls.
brandlanguages	list	No	—	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)
brandname	string	No	—	The name of the brand.
colors	list	No	—	An array of name-value pairs specifying the colors that the brand uses for the following elements: - Button background - Button text - Header background - Header text
defaultbrandlanguage	string	No	—	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)
emailcontent	list	No	—	Deprecated.
errordetails	json	No	—	This object describes errors that occur. It is only valid for responses and ignored in requests.
isorganizationbrand	string	No	—	—
isoverridingcompanyname	boolean	No	—	When true, the brandCompany property is overriding the name of the company in the account settings.
issendingdefault	boolean	No	—	When true, the sending brand is the default brand for sending new envelopes.
issigningdefault	boolean	No	—	When true, the siging brand is the default brand for the signing experience.
landingpages	list	No	—	An array of name/value pairs specifying the pages to which the user is redirected after the following events occur: - Signing Completed - Viewed Exit - Finish Later - Decline - Session Timeout - Authentication Failure If you do not specify landing pages, the Docusign default pages are used.
links	list	No	—	An array of brandLink objects that contain information about the links that the brand uses.
logoids	json	No	—	—
logos	json	No	—	The URIs for retrieving the logos that are associated with the brand. These are read-only properties that provide a URI to logos in use. To update a logo use AccountBrands: updateLogo.
organizationbrandlogo	string	No	—	—
resources	json	No	—	Brands use resource files to style the following experiences: - Email - Sending - Signing - Captive (embedded) signing You can modify these resource files to customize these experiences.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /v2.1/accounts/{accountId}/brands/
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /v2.1/accounts/{accountId}/brands/
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.account-brands.put-brand",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "brandid": "value"
  }
}