AccountBrands: listResources

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 unique identifier for a brand. This property is used to apply branding to an envelope.

Responses

CodeDescriptionReference
200

Successful response.

brandResourcesList
400

Error encountered.

errorDetails

SDK Method

Accounts::getBrandResources

Definitions

brandResources

createdByUserInfouserInfo

createdDatestring

The creation date of the account in UTC timedate format.

dataNotSavedNotInMaster[array]

modifiedByUserInfouserInfo

modifiedDatestring

Most recent date on which this user record was modified.

modifiedTemplates[array]

resourcesContentTypestring

resourcesContentUristring

brandResourcesList

resourcesContentTypes[brandResources]

errorDetails

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

errorCodestring

A 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 of the account associated with the current workspace user.

activationAccessCodestring

Access code provided to the user to activate the account.

emailstring

Filters returned user records by the specified email address.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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

URI containing the user ID.

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Administrator on the account, this can be another user the Admin user is accessing. Note: For Envelopes:listStatusChanges (GET /v2.1/accounts/{accountId}/envelopes), the user_id query parameter is not implemented and should not be used.

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> 
}} />