DocuSign: Gets the brand information for a group
DocuSign esignature.esignatureBrandsGetGroupBrands: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_brands_getgroupbrands
Provider route: GET /restapi/v2.1/accounts/{accountId}/groups/{groupId}/brands. 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"]["esignatureBrandsGetGroupBrands"]>[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.esignatureBrandsGetGroupBrands(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_brands_get_group_brands(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.groupId | 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 Adds an existing brand to a group — response body |
Referenced models: Adds an existing brand to a group — response body
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
Adds an existing brand to a group — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | If your account includes multiple signing brands, you can use the groups functionality to assign different brands to different groups. This resource enables you to manage group brands. |
brandOptions | array | Optional | A list of brands. |
brandOptions[] | Model | Each item | Expand Updates an existing brand — response body |
recipientBrandIdDefault | string | Optional | The brand that envelope recipients see when a brand is not explicitly set. |
senderBrandIdDefault | string | Optional | The brand that envelope senders see when a brand is not explicitly set. |
Referenced models: Updates an existing brand — response body
Updates an existing brand — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope. |
brandCompany | string | Optional | The name of the company associated with the brand. |
brandId | string | Optional | The ID used to identify a specific brand in API calls. |
brandLanguages | array | Optional | An array of two-letter codes for the languages that you want to use with the brand. The supported languages are: - Arabic (`ar`) - Armenian (`hy`) - Bahasa Indonesia (`id`) - Bahasa Malay (`ms`) - Bulgarian (`bg`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Czech (`cs`) - Danish (`da`) - Dutch (`nl`) - English UK (`en_GB`) - English US (`en`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canada (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brasil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukranian (`uk`) - Vietnamese (`vi`) |
brandLanguages[] | string | Each item | |
brandName | string | Optional | The name of the brand. |
colors | array | Optional | An array of name-value pairs specifying the colors that the brand uses for the following elements: - Button background - Button text - Header background - Header text |
colors[] | Model | Each item | Expand Updates an existing brand — response body — colors item |
defaultBrandLanguage | string | Optional | The two-letter code for the language that you want to use as the brand default. The supported languages are: - Arabic (`ar`) - Armenian (`hy`) - Bahasa Indonesia (`id`) - Bahasa Malay (`ms`) - Bulgarian (`bg`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Czech (`cs`) - Danish (`da`) - Dutch (`nl`) - English UK (`en_GB`) - English US (`en`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canada (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brasil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukranian (`uk`) - Vietnamese (`vi`) |
emailContent | array | Optional | Deprecated. |
emailContent[] | Model | Each item | Expand Updates an existing brand — response body — email Content item |
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. |
isOrganizationBrand | string | Optional | |
isOverridingCompanyName | boolean | Optional | When **true,** the `brandCompany` property is overriding the name of the company in the account settings. |
isSendingDefault | boolean | Optional | When **true,** the sending brand is the default brand for sending new envelopes. |
isSigningDefault | boolean | Optional | When **true,** the siging brand is the default brand for the signing experience. |
landingPages | array | Optional | An array of name/value pairs specifying the pages to which the user is redirected after the following events occur: - Signing Completed - Viewed Exit - Finish Later - Decline - Session Timeout - Authentication Failure If you do not specify landing pages, the Docusign default pages are used. |
landingPages[] | Model | Each item | Expand Updates an existing brand — response body — colors item |
links | array | Optional | An array of `brandLink` objects that contain information about the links that the brand uses. |
links[] | Model | Each item | Expand Updates an existing brand — response body — links item |
logoIds | Model | Optional | Expand Updates an existing brand — response body — logo Ids |
logos | Model | Optional | Expand Updates an existing brand — response body — logos The URIs for retrieving the logos that are associated with the brand. |
organizationBrandLogo | string | Optional | |
resources | Model | Optional | Expand Updates an existing brand — response body — resources An object containing the URLs for the four Docusign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience. **Note:** This object is returned only when the `resourceContentType` is `sending`, `signing`, `email`, or `signing_captive`. |
Referenced models: Updates an existing brand — response body — email Content item, Updates an existing brand — response body — links item, Updates an existing brand — response body — logo Ids, Updates an existing brand — response body — logos, Updates an existing brand — response body — resources, Locks a template — response body — error Details, Updates an existing brand — response body — colors item
Updates an existing brand — response body — email Content item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Deprecated. |
content | string | Optional | Deprecated. |
emailContentType | string | Optional | Deprecated. |
emailToLink | string | Optional | Deprecated. |
linkText | string | Optional | Deprecated. |
Updates an existing brand — response body — links item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a link that a brand uses. |
linkText | string | Optional | The text used for the link. |
linkType | string | Optional | The type of link. Valid values include: - `aboutDocusign` - `closeButton` |
showLink | string | Optional | When **true,** the link displays to the recipient. |
urlOrMailTo | string | Optional | The URL or mailto address of the link. |
Updates an existing brand — response body — logo Ids
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
emailLogoId | string | Optional | |
primaryLogoId | string | Optional | |
secondaryLogoId | string | Optional |
Updates an existing brand — response body — logos
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The URIs for retrieving the logos that are associated with the brand. These are read-only properties that provide a URI to logos in use. To update a logo use [AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/). |
email | string | Optional | The URI for the brand's secondary logo. This is a read-only property that provides a URI to the logo in use. To update a logo use [AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/). |
primary | string | Optional | The URI for the brand's secondary logo. This is a read-only property that provides a URI to the logo in use. To update a logo use [AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/). |
secondary | string | Optional | The URI for the brand's secondary logo. This is a read-only property that provides a URI to the logo in use. To update a logo use [AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/). |
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_brands_getgroupbrands. Catalog operation: esignature:Brands_GetGroupBrands. 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.