Retrieves the email override settings for the specified envelope.


HTTP request

GET /v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings


Parameter name Value Description
Path parameters
accountId string

The external account number (int) or account ID Guid.

envelopeId string

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec


Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method


Definitions Expand All | Collapse All


Envelope email settings


A list of email addresses that receive a copy of all email communications for an envelope. You can use this for archiving purposes.

replyEmailAddressOverride string
replyEmailNameOverride string


Contains information about the BCC email address.

bccEmailAddressId string

Only 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 '' and you send an envelope using the BCC Email Override to send a BCC email to '', then a copy of the envelope is only sent to the '' email address.

email string

Specifies 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.


This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.


Generic JSON Response


"replyEmailAddressOverride": "sample string 1",
"replyEmailNameOverride": "sample string 2",
"bccEmailAddresses": [
"bccEmailAddressId": "sample string 1",
"email": "sample string 2"

Generic XML Response



<bccEmailAddressId>sample string 1</bccEmailAddressId>
<email>sample string 2</email>
<replyEmailAddressOverride>sample string 1</replyEmailAddressOverride>
<replyEmailNameOverride>sample string 2</replyEmailNameOverride>