Envelopes: updateNotificationSettings

This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope.

Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.

Request

HTTP request

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

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.

notification
400

Error encountered.

errorDetails

SDK Method

Envelopes::updateNotificationSettings

Definitions

envelopeNotificationRequest

A complex element that specifies the notification settings for the envelope.

expirationsexpirations

A complex element that specifies the expiration settings for the envelope.

remindersreminders

A complex element that specifies reminder settings for the envelope

useAccountDefaultsstring

When set to true, the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When set to false, the reminders and expirations settings specified in this request are used.

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.

expirations

A complex element that specifies the expiration settings for the envelope.

expireAfterstring

An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired.

expireEnabledstring

When set to true, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (sentDateTime). Set expireAfter to set the number of days until an envelope expires. When false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

expireWarnstring

An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

notification

A complex element that specifies the notification settings for the envelope.

expirationsexpirations

A complex element that specifies the expiration settings for the envelope.

remindersreminders

A complex element that specifies reminder settings for the envelope

useAccountDefaultsstring

When set to true, the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When set to false, the reminders and expirations settings specified in this request are used.

reminders

A complex element that specifies reminder settings for the envelope.

reminderDelaystring

An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.

reminderEnabledstring

When set to true, the envelope expires and is no longer available for signing after the specified number of days. When false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

reminderFrequencystring

An integer specifying the interval in days between reminder emails.

Examples

Generic JSON Request/Response

Request
{
  "useAccountDefaults": "sample string 1",
  "reminders": {
    "reminderEnabled": "sample string 1",
    "reminderDelay": "sample string 2",
    "reminderFrequency": "sample string 3"
  },
  "expirations": {
    "expireEnabled": "sample string 1",
    "expireAfter": "sample string 2",
    "expireWarn": "sample string 3"
  }
}
Response
{
  "useAccountDefaults": "sample string 1",
  "reminders": {
    "reminderEnabled": "sample string 1",
    "reminderDelay": "sample string 2",
    "reminderFrequency": "sample string 3"
  },
  "expirations": {
    "expireEnabled": "sample string 1",
    "expireAfter": "sample string 2",
    "expireWarn": "sample string 3"
  }
}
Generic XML Request/Response

Request
<notification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <expirations>
    <expireAfter>sample string 2</expireAfter>
    <expireEnabled>sample string 1</expireEnabled>
    <expireWarn>sample string 3</expireWarn>
  </expirations>
  <reminders>
    <reminderDelay>sample string 2</reminderDelay>
    <reminderEnabled>sample string 1</reminderEnabled>
    <reminderFrequency>sample string 3</reminderFrequency>
  </reminders>
  <useAccountDefaults>sample string 1</useAccountDefaults>
</notification> 
Response
<notification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <expirations>
    <expireAfter>sample string 2</expireAfter>
    <expireEnabled>sample string 1</expireEnabled>
    <expireWarn>sample string 3</expireWarn>
  </expirations>
  <reminders>
    <reminderDelay>sample string 2</reminderDelay>
    <reminderEnabled>sample string 1</reminderEnabled>
    <reminderFrequency>sample string 3</reminderFrequency>
  </reminders>
  <useAccountDefaults>sample string 1</useAccountDefaults>
</notification> 
}} />