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).
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
The ID of the brand.
Query Parameters
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
application/json
Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.
The name of the company associated with the brand.
The ID used to identify a specific brand in API calls.
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)
The name of the brand.
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
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)
Deprecated.
This object describes errors that occur. It is only valid for responses and ignored in requests.
When true, the brandCompany property is overriding the name of the company in the account settings.
When true, the sending brand is the default brand for sending new envelopes.
When true, the siging brand is the default brand for the signing experience.
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.
An array of brandLink objects that contain information about the links that the brand uses.
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.
Brands use resource files to style the following experiences:
- Sending
- Signing
- Captive (embedded) signing
You can modify these resource files to customize these experiences.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v2.1/accounts/string/brands/string" \ -H "Content-Type: application/json" \ -d '{}'{ "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" }}Deletes a brand DELETE
This method deletes a [brand](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/branding/) from an account. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
Exports a brand GET
This method exports information about a brand to an XML file. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).