Request

HTTP request

PUT /v2/accounts/{accountId}/brands/{brandId}

Parameters

Parameter name Value Description
Path parameters
accountId string

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

brandId string

The unique identifier of a brand.

Request Body

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Accounts::updateBrand

Definitions Expand All | Collapse All

brand

brandCompany string

The name of the company associated with this brand.

brandId string

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

brandName string

The name of the brand.

colors
[nameValue]
emailContent
[brandEmailContent]
errorDetails errorDetails
isOverridingCompanyName string
isSendingDefault string
isSigningDefault string
landingPages
[nameValue]
links
[brandLink]
logos brandLogos
resources brandResourceUrls

brandEmailContent

content string
emailContentType string
emailToLink string
linkText string

brandLogos

email string
primary string
secondary string

brandResourceUrls

email string
sending string
signing string
signingCaptive string

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

nameValue

errorDetails errorDetails
name string

The name or key of a name/value pair.

originalValue string

The initial value of the tab when it was sent to the recipient.

value string

The value field of a name/value pair.

Examples

Generic JSON Request/Response

Request

{
"brandCompany": "sample string 1",
"brandId": "sample string 2",
"brandName": "sample string 3",
"colors": [
{}
]
,
"isOverridingCompanyName": "sample string 4",
"isSendingDefault": "sample string 5",
"isSigningDefault": "sample string 6",
"landingPages": [
{}
]
,
"links": [
{
"linkType": "sample string 1",
"urlOrMailTo": "sample string 2",
"linkText": "sample string 3",
"showLink": "sample string 4"
}
]
,
"emailContent": [
{
"emailContentType": "sample string 1",
"content": "sample string 2",
"emailToLink": "sample string 3",
"linkText": "sample string 4"
}
]
,
"logos": {
"primary": "sample string 1",
"secondary": "sample string 2",
"email": "sample string 3"
}
,
"resources": {
"email": "sample string 1",
"sending": "sample string 2",
"signing": "sample string 3",
"signingCaptive": "sample string 4"
}
}

Response

{
"brandCompany": "sample string 1",
"brandId": "sample string 2",
"brandName": "sample string 3",
"colors": [
{}
]
,
"errorDetails": {
"errorCode": "sample string 1",
"message": "sample string 2"
}
,
"isOverridingCompanyName": "sample string 4",
"isSendingDefault": "sample string 5",
"isSigningDefault": "sample string 6",
"landingPages": [
{}
]
,
"links": [
{
"linkType": "sample string 1",
"urlOrMailTo": "sample string 2",
"linkText": "sample string 3",
"showLink": "sample string 4"
}
]
,
"emailContent": [
{
"emailContentType": "sample string 1",
"content": "sample string 2",
"emailToLink": "sample string 3",
"linkText": "sample string 4"
}
]
,
"logos": {
"primary": "sample string 1",
"secondary": "sample string 2",
"email": "sample string 3"
}
,
"resources": {
"email": "sample string 1",
"sending": "sample string 2",
"signing": "sample string 3",
"signingCaptive": "sample string 4"
}
}

Generic XML Request/Response

Request

<brand 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<brandCompany>sample string 1</brandCompany>
<brandId>sample string 2</brandId>
<brandName>sample string 3</brandName>
<colors>
<nameValue />
</colors>
<emailContent>
<brandEmailContent>
<content>sample string 2</content>
<emailContentType>sample string 1</emailContentType>
<emailToLink>sample string 3</emailToLink>
<linkText>sample string 4</linkText>
</brandEmailContent>
</emailContent>
<isOverridingCompanyName>sample string 4</isOverridingCompanyName>
<isSendingDefault>sample string 5</isSendingDefault>
<isSigningDefault>sample string 6</isSigningDefault>
<landingPages>
<nameValue />
</landingPages>
<links>
<brandLink>
<linkText>sample string 3</linkText>
<linkType>sample string 1</linkType>
<showLink>sample string 4</showLink>
<urlOrMailTo>sample string 2</urlOrMailTo>
</brandLink>
</links>
<logos>
<email>sample string 3</email>
<primary>sample string 1</primary>
<secondary>sample string 2</secondary>
</logos>
<resources>
<email>sample string 1</email>
<sending>sample string 2</sending>
<signing>sample string 3</signing>
<signingCaptive>sample string 4</signingCaptive>
</resources>
</brand>

Response

<brand 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<brandCompany>sample string 1</brandCompany>
<brandId>sample string 2</brandId>
<brandName>sample string 3</brandName>
<colors>
<nameValue />
</colors>
<emailContent>
<brandEmailContent>
<content>sample string 2</content>
<emailContentType>sample string 1</emailContentType>
<emailToLink>sample string 3</emailToLink>
<linkText>sample string 4</linkText>
</brandEmailContent>
</emailContent>
<errorDetails>
<errorCode>sample string 1</errorCode>
<message>sample string 2</message>
</errorDetails>
<isOverridingCompanyName>sample string 4</isOverridingCompanyName>
<isSendingDefault>sample string 5</isSendingDefault>
<isSigningDefault>sample string 6</isSigningDefault>
<landingPages>
<nameValue />
</landingPages>
<links>
<brandLink>
<linkText>sample string 3</linkText>
<linkType>sample string 1</linkType>
<showLink>sample string 4</showLink>
<urlOrMailTo>sample string 2</urlOrMailTo>
</brandLink>
</links>
<logos>
<email>sample string 3</email>
<primary>sample string 1</primary>
<secondary>sample string 2</secondary>
</logos>
<resources>
<email>sample string 1</email>
<sending>sample string 2</sending>
<signing>sample string 3</signing>
<signingCaptive>sample string 4</signingCaptive>
</resources>
</brand>