Skip to navigation
Docusign eSignature REST APIEnvelopes

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.

Important: Email addresses where non-archival, general business activity may occur are not suitable and should not be used for email archiving with this feature. Customers are strongly advised to implement special archival email addresses with heightened access controls due to the increased sensitivity associated with notifications delivered to the archival email address using this feature. See Email Archive Configuration for more information.

Methods supported

MethodDescription
createPOST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings
Adds email setting overrides to an envelope.
deleteDEL /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings
Deletes the email setting overrides for an envelope.
getGET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings
Gets the email setting overrides for an envelope.
updatePUT /restapi/v2.1/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.

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@mycompany.com and you send an envelope using the BCC Email Override to send a BCC email to salesarchive@mycompany.com, then a copy of the envelope is only sent to the salesarchive@mycompany.com email address.
replyEmailAddressOverridestringThe Reply To email address to use for email replies, instead of the sending user’s email address. Docusign verifies that the email address is in a correct format, but does not verify that it is active. Maximum length: 100 characters.
replyEmailNameOverridestringThe name to associate with the Reply To email address, instead of the sender’s name. Maximum length: 100 characters.