AccountBrands: listResources

This method returns metadata about the branding resources that are associated with 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).

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

brandIdstring

The id of the brand.

Responses

CodeDescriptionReference
200

Successful response.

brandResourcesList
400

Error encountered.

errorDetails

SDK Method

Accounts::getBrandResources

Definitions

brandResources

Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences.

createdByUserInfouserInfo

The user id of the user who created the brand resource.

createdDatestring

The date and time that the brand resource was created.

dataNotSavedNotInMaster[array]

Deprecated.

modifiedByUserInfouserInfo

Information about the user who last modified the brand resource.

modifiedDatestring

The date on which this user record was last modified.

modifiedTemplates[array]

This property is returned in the response to the AccountBrands::listResources request. It contains a list of any email templates that have been modified to differ from the master resource files.

resourcesContentTypestring

The type of brand resource file. A brand uses a different resource file to control each of the following experiences:

  • Sending (sending)
  • Signing (signing)
  • Email messages (email)
  • Captive (embedded) signing (signing_captive)

You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience.

resourcesContentUristring

The URI for the brand resource file.

brandResourcesList

resourcesContentTypes[brandResources]

A list of resources that the brand uses.

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.

userInfo

accountIdstring

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

accountNamestring

The name on the account.

activationAccessCodestring

Access code provided to the user to activate the account.

emailstring

errorDetailserrorDetails

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

loginStatusstring

Boolean value that indicates whether the user is currently logged in or not.

membershipIdstring

The user's membership ID.

sendActivationEmailstring

When set to true, specifies that an activation email be sent to the user.

uristring

A URI containing the user ID.

userIdstring

The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, userId can represent another user whom the Administrator is accessing.

userNamestring

The name of the user.

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

userTypestring

The type of user, for example CompanyUser.

Examples

Generic JSON Response

Response
{
  "resourcesContentTypes": [
    {
      "resourcesContentType": "sample string 1",
      "modifiedTemplates": [
        "sample string 1"
      ],
      "createdDate": "sample string 2",
      "createdByUserInfo": {
        "userName": "sample string 1",
        "userId": "sample string 2",
        "email": "sample string 3",
        "userType": "sample string 4",
        "userStatus": "sample string 5",
        "uri": "sample string 6",
        "loginStatus": "sample string 7",
        "sendActivationEmail": "sample string 8",
        "activationAccessCode": "sample string 9",
        "errorDetails": {
          "errorCode": "sample string 1",
          "message": "sample string 2"
        }
      },
      "modifiedDate": "sample string 3",
      "modifiedByUserInfo": {},
      "resourcesContentUri": "sample string 4"
    }
  ]
}
Generic XML Response

Response
<brandResourcesList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <resourcesContentTypes>
    <brandResources>
      <createdByUserInfo>
        <activationAccessCode>sample string 9</activationAccessCode>
        <email>sample string 3</email>
        <errorDetails>
          <errorCode>sample string 1</errorCode>
          <message>sample string 2</message>
        </errorDetails>
        <loginStatus>sample string 7</loginStatus>
        <sendActivationEmail>sample string 8</sendActivationEmail>
        <uri>sample string 6</uri>
        <userId>sample string 2</userId>
        <userName>sample string 1</userName>
        <userStatus>sample string 5</userStatus>
        <userType>sample string 4</userType>
      </createdByUserInfo>
      <createdDate>sample string 2</createdDate>
      <modifiedByUserInfo />
      <modifiedDate>sample string 3</modifiedDate>
      <modifiedTemplates>
        <string>sample string 1</string>
      </modifiedTemplates>
      <resourcesContentType>sample string 1</resourcesContentType>
      <resourcesContentUri>sample string 4</resourcesContentUri>
    </brandResources>
  </resourcesContentTypes>
</brandResourcesList> 
}} />