PATCH
/
v1
/
envelopes
/
{envelope_id}
// PATCH https://api.signatureapi.com/v1/envelopes/{envelope_id}
// X-API-Key: key_test_...
{
  "label": "Dummy Agreement for Order Ref. 29009"
}

{
  "id": "55072f0e-b919-4d69-89cd-e7e56af00530",
  "title": "Dummy Agreement",
  "label": "Dummy Agreement for Order Ref. 29009",
  "message": "Please review the agreement at your convenience and provide your electronic signature.",
  "status": "completed",
  "mode": "live",
  "timezone": "UTC",
  "timestamp_format": "DD/MM/YYYY HH:mm:ss",
  "sender": {
    "name": "Jennifer Lee",
    "email": "jennifer@example.com",
    "organization": "Acme Enterprises"
  },
  "documents": [
    {
      "id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
      "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
      "title": "Dummy Agreement",
      "page_count": 2,
      "url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/dummy.docx",
      "format": "docx",
      "data": {
        "date": "December 31st, 2025",
        "show_alert": true,
        "service_provider": {
          "name": "Jane Smith",
          "organization": "ACME Global, Inc."
        },
        "client": {
          "name": "Michael J. Miller",
          "organization": "Miller Industries"
        }
      }
    }
  ],
  "recipients": [
    {
      "id": "re_26w2VVV5JVm4j459TY5BNM",
      "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
      "type": "signer",
      "key": "provider",
      "name": "Emily Johnson",
      "email": "emily@example.com",
      "status": "completed",
      "completed_at": "2025-12-31T15:00:00.000Z",
      "status_updated_at": "2025-12-31T15:00:00.000Z"
    },
    {
      "id": "re_38UVwrWdCqX5kqeKFJUTtf",
      "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
      "type": "signer",
      "key": "client",
      "name": "Michael Taylor",
      "email": "michael@example.com",
      "status": "completed",
      "completed_at": "2025-12-31T14:00:00.000Z",
      "status_updated_at": "2025-12-31T14:00:00.000Z"
    }
  ],
  "deliverable": {
    "id": "del_1T7If8GgrTOf7zBVPaJf2e",
    "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
    "status": "generated",
    "type": "audit_log",
    "url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault-dev/envelopes/52872f0e..."
  },
  "created_at": "2025-12-31T12:00:00.000Z",
  "completed_at": "2025-12-31T15:00:00.000Z"
}

Updates an envelope by setting the values of the parameters passed. Any parameters not provided are left unchanged.

Currently, the following envelope parameter can be updated: label.

​
Path Parameters

envelope_id
uuid
required

The unique identifier of an envelope.

​
Body Parameters

label
string

Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to recipients.

​
Returns

Returns a 200 OK status code along with the updated envelope object if successful, or an error otherwise.

// PATCH https://api.signatureapi.com/v1/envelopes/{envelope_id}
// X-API-Key: key_test_...
{
  "label": "Dummy Agreement for Order Ref. 29009"
}

{
  "id": "55072f0e-b919-4d69-89cd-e7e56af00530",
  "title": "Dummy Agreement",
  "label": "Dummy Agreement for Order Ref. 29009",
  "message": "Please review the agreement at your convenience and provide your electronic signature.",
  "status": "completed",
  "mode": "live",
  "timezone": "UTC",
  "timestamp_format": "DD/MM/YYYY HH:mm:ss",
  "sender": {
    "name": "Jennifer Lee",
    "email": "jennifer@example.com",
    "organization": "Acme Enterprises"
  },
  "documents": [
    {
      "id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
      "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
      "title": "Dummy Agreement",
      "page_count": 2,
      "url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/dummy.docx",
      "format": "docx",
      "data": {
        "date": "December 31st, 2025",
        "show_alert": true,
        "service_provider": {
          "name": "Jane Smith",
          "organization": "ACME Global, Inc."
        },
        "client": {
          "name": "Michael J. Miller",
          "organization": "Miller Industries"
        }
      }
    }
  ],
  "recipients": [
    {
      "id": "re_26w2VVV5JVm4j459TY5BNM",
      "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
      "type": "signer",
      "key": "provider",
      "name": "Emily Johnson",
      "email": "emily@example.com",
      "status": "completed",
      "completed_at": "2025-12-31T15:00:00.000Z",
      "status_updated_at": "2025-12-31T15:00:00.000Z"
    },
    {
      "id": "re_38UVwrWdCqX5kqeKFJUTtf",
      "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
      "type": "signer",
      "key": "client",
      "name": "Michael Taylor",
      "email": "michael@example.com",
      "status": "completed",
      "completed_at": "2025-12-31T14:00:00.000Z",
      "status_updated_at": "2025-12-31T14:00:00.000Z"
    }
  ],
  "deliverable": {
    "id": "del_1T7If8GgrTOf7zBVPaJf2e",
    "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
    "status": "generated",
    "type": "audit_log",
    "url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault-dev/envelopes/52872f0e..."
  },
  "created_at": "2025-12-31T12:00:00.000Z",
  "completed_at": "2025-12-31T15:00:00.000Z"
}

Was this page helpful?

Get an envelopeDelete an envelope