Signatures
Envelope Edit
Edits notification-related settings for an already sent envelope.
- The envelope is identified using the envelopeId path parameter.
- This endpoint allows updating:
- Envelope expiration settings
- Envelope notification settings, including:
- Expiration period
- Alerts for recipients
- Note: Documents, recipients, or fields within the envelope are not modified — only expiration/notification settings.
expireInDaysmust be at least 2 and at leastalertDaysBeforeExpiry, and the resulting expiry date must not already be in the past.
AuthorizationBearer <token>
JWT token to authenticate the request.
In: header
X-Api-Key<token>
API key, sent as a request header.
In: header
Path Parameters
envelopeId*string
The envelopeId parameter in the URL is a unique identifier for the envelope whose notification settings are being edited. It specifies which already-sent envelope should be updated with the new expiration and alert configurations.
Header Parameters
X-Origin-IpAddress?string
Caller IP address, recorded in the audit trail. Not validated.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PUT "https://example.com/signatures/envelope/string/edit" \ -H "Content-Type: application/json" \ -d '{ "envelope": { "expireInDays": 7, "alertDaysBeforeExpiry": 3 }, "externalContext": { "id": "12345" } }'{ "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "string", "message": "string" } } }, "origin": "string", "dateTime": "string"}{ "error": { "message": "Envelope not found.", "statusCode": 400, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "POST https://apim-mavenheadless-dev-westeu-1.azure-api.net/v1/signatures/envelope/create", "dateTime": "2026-07-20T12:00:00.0000000+00:00"}{ "error": { "message": "Envelope not found.", "statusCode": 400, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "POST https://apim-mavenheadless-dev-westeu-1.azure-api.net/v1/signatures/envelope/create", "dateTime": "2026-07-20T12:00:00.0000000+00:00"}