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/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. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

CodeDescriptionReference
200

Successful response.

EnvelopeEmailSettings
400

Error encountered.

errorDetails

SDK Method

Envelopes::updateEmailSettings

Definitions

bccEmailAddress
errorDetails
EnvelopeEmailSettings

Examples

Generic JSON Request/Response
Generic XML Request/Response