Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made.

This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.

Request

HTTP request

PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

CodeDescriptionReference
200

Successful response.

EnvelopeEmailSettings
400

Error encountered.

errorDetails

SDK Method

Envelopes::updateEmailSettings

Definitions

bccEmailAddress

Contains information about the BCC email address.

bccEmailAddressIdstring

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.

emailstring

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.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

EnvelopeEmailSettings

Envelope email settings

bccEmailAddresses[bccEmailAddress]

An array of up to five email addresses that receive a copy of all email communications for an envelope. Maximum Length: 100 characters.

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.

replyEmailAddressOverridestring

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

replyEmailNameOverridestring

The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters.

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> 
}} />