Skip to navigation

EnvelopeEmailSettings Resource

View as Markdown

The EnvelopeEmailSettings provide methods that allow you to manage the email override settings for an envelope.

Email override settings change the reply to email address, name, or the BCC for email archive information, for the envelope. Note that changing email settings will only affect email communications that occur after the addition was made.

The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.

Methods supported

MethodDescription
createPOST /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings
Adds email setting overrides to an envelope.
deleteDEL /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings
Deletes the email setting overrides for an envelope.
getGET /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings
Gets the email setting overrides for an envelope.
updatePUT /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings
Updates the email setting overrides for an envelope.

EnvelopeEmailSettings properties

PropertyTypeDescription
bccEmailAddressesarrayAn 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.

Note: While this property is an array, it takes only a single email address.
replyEmailAddressOverridestring
replyEmailNameOverridestring