DocuSign: Returns metadata about the branding resources for an account
DocuSign esignature.esignatureBrandResourcesGetBrandResourcesList: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_brandresources_getbrandresourceslist
Provider route: GET /restapi/v2.1/accounts/{accountId}/brands/{brandId}/resources. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureBrandResourcesGetBrandResourcesList"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.esignature.esignatureBrandResourcesGetBrandResourcesList(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.esignature.esignature_brand_resources_get_brand_resources_list(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
path.brandId | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Returns metadata about the branding resources for an account — response body |
Referenced models: Returns metadata about the branding resources for an account — response body
Schemas
Section titled “Schemas”Returns metadata about the branding resources for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
resourcesContentTypes | array | Optional | A list of resources that the brand uses. |
resourcesContentTypes[] | Model | Each item | Expand Updates a branding resource file — response body |
Referenced models: Updates a branding resource file — response body
Updates a branding resource file — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences. |
createdByUserInfo | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner The user ID of the user who created the brand resource. |
createdDate | string | Optional | The date and time that the brand resource was created. |
dataNotSavedNotInMaster | array | Optional | Deprecated. |
dataNotSavedNotInMaster[] | string | Each item | |
modifiedByUserInfo | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user who last modified the brand resource. |
modifiedDate | string | Optional | The date on which this user record was last modified. |
modifiedTemplates | array | Optional | This property is returned in the response to the [AccountBrands::listResources][listResources] request. It contains a list of any email templates that have been modified to differ from the master resource files. [listResources]: /docs/esign-rest-api/reference/accounts/accountbrands/listresources/ |
modifiedTemplates[] | string | Each item | |
resourcesContentType | string | Optional | 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. |
resourcesContentUri | string | Optional | The URI for the brand resource file. |
Referenced models: Gets a specific template associated with a specified account — response body — owner
Gets a specific template associated with a specified account — response body — owner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountId | string | Optional | The account ID associated with the envelope. |
accountName | string | Optional | The name on the account. |
activationAccessCode | string | Optional | Access code provided to the user to activate the account. |
email | string | Optional | The user's email address. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
ipAddress | string | Optional | |
loginStatus | string | Optional | When **true,** indicates that the user is logged in. This is a read-only property. |
membershipId | string | Optional | The user's membership ID. |
sendActivationEmail | string | Optional | This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/). |
uri | string | Optional | A URI containing the user ID. |
userId | string | Optional | The ID of the user to access. |
userName | string | Optional | The name of the user. |
userStatus | string | Optional | Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` |
userType | string | Optional | The type of user, for example `CompanyUser`. |
Referenced models: Locks a template — response body — error Details
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_brandresources_getbrandresourceslist. Catalog operation: esignature:BrandResources_GetBrandResourcesList. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.