Update envelope

Updates the details of an existing envelope, such as adding or removing documents, modifying signers, or changing other associated metadata. Be aware that modifications to documents will not be allowed if any signer has already approved the envelope, nor will you be able to change signers who have already approved the envelope. The updated envelope will retain its unique identifier, and changes can be tracked in subsequent operations. Ensure the provided envelope ID exists and the request contains the necessary changes.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Path Params

Body Params application/json

Example

{
    "vaultId": "e5a1a389-d3f3-4dd1-a9f7-cf159d31c4a4",
    "name": "Example Envelope",
    "privateDescription": "Private description of the envelope",
    "publicDescription": "Public description of the envelope",
    "message": "Message of the envelope",
    "reviewReminder": true,
    "expiresAtUtc": "2026-01-06T00:14:44.1068144Z",
    "expirationReminder": true,
    "toBePublishedAtUtc": "2025-12-08T00:14:44.106815Z",
    "language": "EnUs",
    "markupOrientation": "Bottom",
    "signInOrder": true,
    "isAiChatForSignersEnabled": true,
    "signers": [
        {
            "id": "636f1760-4ea7-4ce7-aaa7-bb83739f5f7b",
            "name": "John Doe",
            "email": "john.doe@example.com",
            "allowEmailCommunication": false,
            "role": "Sign",
            "title": "Lawyer",
            "shouldEnforceEmailValidation": true,
            "shouldEnforceSmsValidation": true,
            "shouldEnforceWhatsAppValidation": true,
            "shouldEnforcePixValidation": true,
            "shouldEnforceGeolocationValidation": true,
            "shouldEnforceCustomDigitalCertificateValidation": true,
            "phoneIdd": 1,
            "phoneNumber": "5555555555",
            "allowPhoneSmsCommunication": false,
            "allowPhoneWhatsAppCommunication": false,
            "documentType": "GenericIdentification",
            "documentValue": "1234567890",
            "shouldEnforcePasscodeValidation": true,
            "passcode": "123456",
            "passcodeHint": "1 to 6",
            "signMarks": [
                {
                    "id": "081334cd-15d7-401b-8020-145e5cc893a2",
                    "type": "Rubric",
                    "documentId": "9537a60e-c049-482a-a26a-cf1cf08b85b8",
                    "page": 1,
                    "x": 150,
                    "y": 50,
                    "rotation": 0
                },
                {
                    "id": null,
                    "type": "Signature",
                    "documentId": "9537a60e-c049-482a-a26a-cf1cf08b85b8",
                    "page": 2,
                    "x": 200,
                    "y": 50,
                    "rotation": 0
                }
            ]
        }
    ],
    "documents": [
        {
            "id": "9537a60e-c049-482a-a26a-cf1cf08b85b8",
            "name": "Example Document",
            "privateDescription": "Private description of the document",
            "publicDescription": "Public description of the document",
            "language": "EnUs",
            "markupOrientation": "Bottom"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.signater.com/v1/ecm/envelopes/' \
--header 'x-api-token: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "vaultId": "e5a1a389-d3f3-4dd1-a9f7-cf159d31c4a4",
    "name": "Example Envelope",
    "privateDescription": "Private description of the envelope",
    "publicDescription": "Public description of the envelope",
    "message": "Message of the envelope",
    "reviewReminder": true,
    "expiresAtUtc": "2026-01-06T00:14:44.1068144Z",
    "expirationReminder": true,
    "toBePublishedAtUtc": "2025-12-08T00:14:44.106815Z",
    "language": "EnUs",
    "markupOrientation": "Bottom",
    "signInOrder": true,
    "isAiChatForSignersEnabled": true,
    "signers": [
        {
            "id": "636f1760-4ea7-4ce7-aaa7-bb83739f5f7b",
            "name": "John Doe",
            "email": "john.doe@example.com",
            "allowEmailCommunication": false,
            "role": "Sign",
            "title": "Lawyer",
            "shouldEnforceEmailValidation": true,
            "shouldEnforceSmsValidation": true,
            "shouldEnforceWhatsAppValidation": true,
            "shouldEnforcePixValidation": true,
            "shouldEnforceGeolocationValidation": true,
            "shouldEnforceCustomDigitalCertificateValidation": true,
            "phoneIdd": 1,
            "phoneNumber": "5555555555",
            "allowPhoneSmsCommunication": false,
            "allowPhoneWhatsAppCommunication": false,
            "documentType": "GenericIdentification",
            "documentValue": "1234567890",
            "shouldEnforcePasscodeValidation": true,
            "passcode": "123456",
            "passcodeHint": "1 to 6",
            "signMarks": [
                {
                    "id": "081334cd-15d7-401b-8020-145e5cc893a2",
                    "type": "Rubric",
                    "documentId": "9537a60e-c049-482a-a26a-cf1cf08b85b8",
                    "page": 1,
                    "x": 150,
                    "y": 50,
                    "rotation": 0
                },
                {
                    "id": null,
                    "type": "Signature",
                    "documentId": "9537a60e-c049-482a-a26a-cf1cf08b85b8",
                    "page": 2,
                    "x": 200,
                    "y": 50,
                    "rotation": 0
                }
            ]
        }
    ],
    "documents": [
        {
            "id": "9537a60e-c049-482a-a26a-cf1cf08b85b8",
            "name": "Example Document",
            "privateDescription": "Private description of the document",
            "publicDescription": "Public description of the document",
            "language": "EnUs",
            "markupOrientation": "Bottom"
        }
    ]
}'

Request

Request Code Samples

Responses