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

Important: 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.

Request

HTTP request

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

Parameters

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

Request Body

Responses

Code Description Reference
201 Created Successful response.
400 Bad Request Error encountered.

SDK Method

Envelopes::createEmailSettings

Definitions Expand All | Collapse All

EnvelopeEmailSettings

Envelope email settings

bccEmailAddresses
[bccEmailAddress]

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

bccEmailAddress

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

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.

errorDetails

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.

Examples

Generic JSON Request/Response

Request

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

Response

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

Generic XML Request/Response

Request

<emailSettings 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<bccEmailAddresses>
<bccEmailAddress>
<bccEmailAddressId>sample string 1</bccEmailAddressId>
<email>sample string 2</email>
</bccEmailAddress>
</bccEmailAddresses>
<replyEmailAddressOverride>sample string 1</replyEmailAddressOverride>
<replyEmailNameOverride>sample string 2</replyEmailNameOverride>
</emailSettings>

Response

<emailSettings 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<bccEmailAddresses>
<bccEmailAddress>
<bccEmailAddressId>sample string 1</bccEmailAddressId>
<email>sample string 2</email>
</bccEmailAddress>
</bccEmailAddresses>
<replyEmailAddressOverride>sample string 1</replyEmailAddressOverride>
<replyEmailNameOverride>sample string 2</replyEmailNameOverride>
</emailSettings>