Skip to content

DocuSign: Deletes brand information from a group

DocuSign esignature.esignatureBrandsDeleteGroupBrands: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_brands_deletegroupbrands

Provider route: DELETE /restapi/v2.1/accounts/{accountId}/groups/{groupId}/brands. Alter supplies the connection’s credentials and routing.

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"]["esignatureBrandsDeleteGroupBrands"]>[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.esignatureBrandsDeleteGroupBrands(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_delete_group_brands(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.groupIdstringRequired within parent
bodyModelOptionalExpand Adds an existing brand to a group — request body — body

Referenced models: Adds an existing brand to a group — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Adds an existing brand to a group — response body

Referenced models: Adds an existing brand to a group — response body

3 more schemas are linked from the tables above, on the schema pages.

Adds an existing brand to a group — response body
FieldTypePresenceDescription and constraints
$objectRootIf 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.
brandOptionsarrayOptionalA list of brands.
brandOptions[]ModelEach itemExpand Updates an existing brand — response body
recipientBrandIdDefaultstringOptionalThe brand that envelope recipients see when a brand is not explicitly set.
senderBrandIdDefaultstringOptionalThe brand that envelope senders see when a brand is not explicitly set.

Referenced models: Updates an existing brand — response body

Adds an existing brand to a group — request body — body
FieldTypePresenceDescription and constraints
$objectRootDetails about one or more brands.
brandsarrayOptionalA list of brands.
brands[]ModelEach itemExpand Adds an existing brand to a group — request body — body brands item

Referenced models: Adds an existing brand to a group — request body — body brands item

Updates an existing brand — response body
FieldTypePresenceDescription and constraints
$objectRootInformation about a brand that is associated with an account. A brand applies custom styles and text to an envelope.
brandCompanystringOptionalThe name of the company associated with the brand.
brandIdstringOptionalThe ID used to identify a specific brand in API calls.
brandLanguagesarrayOptionalAn 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[]stringEach item
brandNamestringOptionalThe name of the brand.
colorsarrayOptionalAn 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[]ModelEach itemExpand Updates an existing brand — response body — colors item
defaultBrandLanguagestringOptionalThe 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`)
emailContentarrayOptionalDeprecated.
emailContent[]ModelEach itemExpand Updates an existing brand — response body — email Content item
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
isOrganizationBrandstringOptional
isOverridingCompanyNamebooleanOptionalWhen **true,** the `brandCompany` property is overriding the name of the company in the account settings.
isSendingDefaultbooleanOptionalWhen **true,** the sending brand is the default brand for sending new envelopes.
isSigningDefaultbooleanOptionalWhen **true,** the siging brand is the default brand for the signing experience.
landingPagesarrayOptionalAn 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[]ModelEach itemExpand Updates an existing brand — response body — colors item
linksarrayOptionalAn array of `brandLink` objects that contain information about the links that the brand uses.
links[]ModelEach itemExpand Updates an existing brand — response body — links item
logoIdsModelOptionalExpand Updates an existing brand — response body — logo Ids
logosModelOptionalExpand Updates an existing brand — response body — logos
The URIs for retrieving the logos that are associated with the brand.
organizationBrandLogostringOptional
resourcesModelOptionalExpand 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

Adds an existing brand to a group — request body — body brands item
FieldTypePresenceDescription and constraints
$objectRootThis request object contains information about a specific brand.
brandIdstringOptionalThe ID of the brand used in API calls
Updates an existing brand — response body — email Content item
FieldTypePresenceDescription and constraints
$objectRootDeprecated.
contentstringOptionalDeprecated.
emailContentTypestringOptionalDeprecated.
emailToLinkstringOptionalDeprecated.
linkTextstringOptionalDeprecated.
Updates an existing brand — response body — links item
FieldTypePresenceDescription and constraints
$objectRootInformation about a link that a brand uses.
linkTextstringOptionalThe text used for the link.
linkTypestringOptionalThe type of link. Valid values include:

- `aboutDocusign`
- `closeButton`
showLinkstringOptionalWhen **true,** the link displays to the recipient.
urlOrMailTostringOptionalThe URL or mailto address of the link.
Updates an existing brand — response body — logo Ids
FieldTypePresenceDescription and constraints
$objectRoot
emailLogoIdstringOptional
primaryLogoIdstringOptional
secondaryLogoIdstringOptional
Updates an existing brand — response body — resources
FieldTypePresenceDescription and constraints
$objectRootBrands use resource files to style the following experiences:

- Email
- Sending
- Signing
- Captive (embedded) signing

You can modify these resource files to customize these experiences.
emailstringOptionalThe URI for the email resource file that the brand uses.
sendingstringOptionalThe URI for the sending resource file that the brand uses.
signingstringOptionalThe URI for the signing resource file that the brand uses.
signingCaptivestringOptionalThe URI for the captive (embedded) signing resource file that the brand uses.

SDK function policy ID: docusign.esignature_brands_deletegroupbrands. Catalog operation: esignature:Brands_DeleteGroupBrands. 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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.