Skip to content

DocuSign: Gets the email setting overrides for an envelope

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

← Esignature operations · Get started

Operation docusign.esignature_emailsettings_getemailsettings

Provider route: GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings. 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"]["esignatureEmailSettingsGetEmailSettings"]>[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.esignatureEmailSettingsGetEmailSettings(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_email_settings_get_email_settings(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.envelopeIdstringRequired within parent

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Adds email setting overrides to an envelope — response body

Referenced models: Adds email setting overrides to an envelope — response body

Adds email setting overrides to an envelope — response body
FieldTypePresenceDescription and constraints
$objectRootA complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent.

When the emailSettings information is used for an envelope, it only applies to that envelope.

**IMPORTANT:** The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings.

EmailSettings consists of:

* replyEmailAddressOverride - The Reply To email used for the envelope. Docusign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters.
* replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters.
* bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option.
Docusign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters.
*Example*: if your account has BCC for Email Archive set up for the email address 'archive@example.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@example.com', then a copy of the envelope is only sent to the 'salesarchive@example.com' email address.
bccEmailAddressesarrayOptionalAn array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters.

While this property is an array, note that it takes only a single email address.

**Note:** Only users with the `canManageAccount` setting set to **true** can use this option.

Docusign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope.

**Example:** if your account has BCC for Email Archive set up for the email address archive@example.com and you send an envelope using the BCC Email Override to send a BCC email to salesarchive@example.com, then a copy of the envelope is only sent to the salesarchive@example.com email address.
bccEmailAddresses[]ModelEach itemExpand Adds email setting overrides to an envelope — response body — bcc Email Addresses item
replyEmailAddressOverridestringOptionalThe Reply To email address to use for email replies, instead of the one that is configured at the account level. Docusign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters.
replyEmailNameOverridestringOptionalThe name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters.

Referenced models: Adds email setting overrides to an envelope — response body — bcc Email Addresses item

Adds email setting overrides to an envelope — response body — bcc Email Addresses item
FieldTypePresenceDescription and constraints
$objectRootContains information about the BCC email address.
bccEmailAddressIdstringOptionalOnly users with canManageAccount setting can use this option. An array of up to 5 email addresses the envelope is sent to as a BCC email.

Example: If your account has BCC for Email Archive set up for the email address 'archive@example.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@example.com', then a copy of the envelope is only sent to the 'salesarchive@example.com' email address.
emailstringOptionalSpecifies the BCC email address. Docusign verifies that the email format is correct, but does not verify that the email is active.Using this overrides the BCC for Email Archive information setting for this envelope.

Maximum of length: 100 characters.

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