Adds email setting overrides to an envelope
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.
The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copy or Certified Delivery recipient type.
Note: Docusign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
The envelope's GUID.
Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
Request Body
application/json
A complex type that contains email settings.
A complex type that contains email settings.
An 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.
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.
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.
Response Body
application/json
application/json
curl -X POST "https://example.com/v2.1/accounts/string/envelopes/string/email_settings" \ -H "Content-Type: application/json" \ -d '{}'{ "bccEmailAddresses": [ { "bccEmailAddressId": "string", "email": "string" } ], "replyEmailAddressOverride": "string", "replyEmailNameOverride": "string"}Gets the email setting overrides for an envelope GET
Retrieves the email override settings for the specified envelope.
Deletes the email setting overrides for an envelope DELETE
Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.