Skip to main content

Get envelope notification settings

GET 

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

Returns the reminder and expiration settings in effect for the envelope. Reminders and the expiration warning are reported only when they are configured on the envelope; otherwise they are disabled and useAccountDefaults is "true". When the envelope has been sent, expireAfter is the number of days from sending until it expires; on a draft it is the configured number of days, which start counting when the envelope is sent. If more than one expiration warning is configured, the earliest is reported as expireWarn. The envelope must exist and belong to your account.

Request​

Responses​

Notification settings.

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>.