Signatures
Envelope Update
Updates an envelope that is created but not yet sent for signing.
- The envelope must be in the "Draft" status.
- The envelope is identified using the envelopeId path parameter.
- This endpoint allows modification of:
- Envelope documents.
- Recipients.
- Fields.
- Envelope settings.
- Associated metadata.
- Use this endpoint to revise envelope details before initiating the signing process. Replaces the entire draft's documents/recipients/signGroups/fields.
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 unique identifier of the envelope to be updated. This ID is generated when the envelope is first created and is used to reference and modify the envelope before it is sent to recipients. It must match an existing envelope that is still in a draft (unsent) status.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Unlike the regular envelope create/update request, documents/fields/recipients are not required to be non-empty here — a template can be saved with none of them.
Response Body
application/json
application/json
application/json
curl -X PUT "https://example.com/signatures/envelope/string/update" \ -H "Content-Type: application/json" \ -d '{ "documents": [ { "referenceDocumentId": 1, "name": "Test Document Name", "loadMethod": "Storage", "urn": "{{uploadedDocument}}" } ], "recipients": [ { "referenceSignerId": 1, "name": "Test Example", "email": "user@example.com", "role": "signer", "mandatory": true } ], "fields": [ { "type": "signature", "isRequired": true, "referenceSignerId": 1, "referenceDocumentId": 1, "positionX": 10, "positionY": 10, "height": 100, "width": 100, "page": 1, "name": "mds_signature1", "properties": { "fontFamily": "Arial", "fontSize": 13, "color": "red", "bold": true, "italic": true, "underline": true, "textAlign": "center" } } ], "envelope": { "subject": "Email Subject", "message": "Email Message", "senderName": "Sender", "senderEmail": "sender@example.com", "isSignOrder": false, "expireInDays": 5, "alertDaysBeforeExpiry": 5, "firstReminderDays": 3, "repeatingReminderDays": 2, "notifyWhenOpened": true, "notifyWhenSigned": true }, "externalContext": { "id": "12345" } }'{ "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "string", "uploadDate": "string", "status": "string" }, "documents": [ { "id": "string", "externalContext": {} } ], "recipients": [ { "id": "string", "externalContext": {} } ], "signGroups": [ { "id": "string" } ], "fields": [ { "id": "string", "recipientId": "string", "signGroupId": "string", "documentId": "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"}