Sets envelope notifications for an existing envelope
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.
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 element that specifies the notification settings for the envelope.
A complex element that specifies the expiration settings for the envelope. When an envelope expires, it is voided and no longer available for signing. Note: there is a short delay between when the envelope expires and when it is voided.
A complex element that specifies reminder settings for the envelope.
When true, the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When false, the reminders and expirations settings specified in this request are used. The default value is false.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v2.1/accounts/string/envelopes/string/notification" \ -H "Content-Type: application/json" \ -d '{}'{ "expirations": { "expireAfter": "string", "expireEnabled": "string", "expireWarn": "string" }, "reminders": { "maximumReminderCount": "string", "reminderDelay": "string", "reminderEnabled": "string", "reminderFrequency": "string", "smartReminderEnabled": "string" }, "useAccountDefaults": "string"}