AccountBrands: getResource

This method returns a specific branding resource file.

A brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience.

Important: When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the 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).

Request

HTTP request

GET /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

brandIdstring

The id of the brand.

resourceContentTypestring

The type of brand resource file to return. Valid values are:

  • sending
  • signing
  • email
  • signing_captive

Optional Query Parameters
langcodestring

The ISO 3166-1 alpha-2 codes for the languages that the brand supports.

return_masterstring

Specifies which resource file data to return. When true, only the master resource file is returned. When false, only the elements that you modified are returned.

Responses

CodeDescriptionReference
200

Successful response.

400

Error encountered.

errorDetails

SDK Method

Accounts::getBrandResourcesByContentType

Definitions

errorDetails

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

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

}} />