Envelopes: getNotificationSettings

Retrieves the envelope notification, reminders and expirations, information for an existing envelope.

Request

HTTP request

GET /v2/accounts/{accountId}/envelopes/{envelopeId}/notification

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

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Envelopes::getNotificationSettings

Definitions Expand All | Collapse All

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.

expirations

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

expireAfter string

An integer that sets the number of days the envelope is active.

expireEnabled string

When set to true, the envelope expires (is no longer available for signing) in the set number of days. If 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.

expireWarn string

An integer that sets the number of days before envelope expiration 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 options for the envelope. It consists of:

  • useAccountDefaults - When set to true, the account default notification settings are used for the envelope.
  • reminders - A complex element that specifies reminder settings for the envelope. It consists of:

    • reminderEnabled - When set to true, a reminder message is sent to the recipient.
    • reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.
    • reminderFrequency - An interger that sets the interval, in days, between reminder emails.
  • expirations - A complex element that specifies the expiration settings for the envelope. It consists of:

    • expireEnabled - When set to true, the envelope expires (is no longer available for signing) in the set number of days. If 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.
    • expireAfter - An integer that sets the number of days the envelope is active.
    • expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.
expirations expirations

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

reminders reminders

A complex element that specifies reminder settings for the envelope

useAccountDefaults string

When set to true, the account default notification settings are used for the envelope.

reminders

A complex element that specifies reminder settings for the envelope

reminderDelay string

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

reminderEnabled string

When set to true, the envelope expires (is no longer available for signing) in the set number of days. If 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.

reminderFrequency string

An interger that sets the interval, in days, between reminder emails.

Examples

Generic JSON Response

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 Response

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>