__INITIALS__
Retrieves the envelope notification, reminders and expirations, information for an existing envelope.
GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification| Parameter Name | Value | Description |
|---|---|---|
| Path Parameters | ||
| accountId | string | The external account number (int) or account ID GUID. |
| envelopeId | string | The envelope's GUID. Example: |
| Code | Description | Reference |
|---|---|---|
| 200 | Successful response. | notification |
| 400 | Error encountered. | errorDetails |
This object describes errors that occur. It is only valid for responses and ignored in requests. | ||
errorCode | string | The code associated with the error condition. |
message | string | A brief message describing the error condition. |
A complex element that specifies the expiration settings for the envelope. | ||
expireAfter | string | 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. |
expireEnabled | string | When set to true, the envelope expires (is no longer available for signing) after the specified number of days after it is sent ( |
expireWarn | string | 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. |
A complex element that specifies the notification settings for the envelope. | ||
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, overriding the reminders and expirations settings. When set to false, the reminders and expirations settings specified in this request are used. |
A complex element that specifies reminder settings for the envelope. | ||
reminderDelay | string | An integer specifying 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 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. |
reminderFrequency | string | An integer specifying the interval in days between reminder emails. |
{
"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"
}
}
<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>