Skip to main content

Update envelope notification settings

PUT 
/restapi/v2.1/accounts/:accountId/envelopes/:envelopeId/notification

Changes the envelope's reminders and/or expiration. Sections that are omitted are left as they are. Works on a draft or an envelope that is in process; completed, declined, voided and expired envelopes return 400.

Reminders are emailed reminderDelay days after the envelope was sent and then every reminderFrequency days to recipients whose turn it is to sign. The envelope expires expireAfter days after it was sent, and an expiration warning is emailed expireWarn days before. Embedded (clientUserId) recipients receive neither. A scheduled job runs twice a day, so reminders, warnings and the move to expired happen at the next run after they are due.

Values that Propper cannot apply are rejected with 400 rather than accepted and ignored: reminderDelay and reminderFrequency are required when reminderEnabled is "true", expireAfter is required when expireEnabled is "true", and expireWarn must be less than expireAfter. Numbers sent with a disabled section are ignored. useAccountDefaults: "true" cannot be combined with reminder or expiration values; on its own it clears the envelope's reminders and expiration. If the new expireAfter has already elapsed for an envelope that was sent earlier, the request returns 400.

Request​

Responses​

The notification settings now in effect.

Response Headers
    X-Request-Id

    Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.

    traceparent

    W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.