Operations

Update an envelope

Update the label of an existing envelope

PATCH

/ v1 / envelopes / {envelope_id}

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

Currently, only the label property can be updated. The label is for internal use and is not shown to recipients. It can be updated regardless of the envelope’s status.

Path parameters

envelope_id

uuid

required

The unique identifier of the envelope, in UUID format.

Body parameters

label

string

A custom label for internal identification. Labels are not shown to recipients. Unlike title, which recipients see, the label is for your team’s use only. It can be updated at any time via the Update Envelope endpoint.

Maximum 500 characters. Defaults to null.

Returns

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

// PATCH https://api.signatureapi.com/v1/envelopes/{envelope_id}
// X-API-Key: key_test_...
// Content-Type: application/json

{
  "label": "Exploration Agreement for Order Ref. 29009"
}

// HTTP/1.1 200 OK
{
  "id": "55072f0e-b919-4d69-89cd-e7e56af00530",
  "title": "Exploration Agreement",
  "label": "Exploration Agreement for Order Ref. 29009",
  //...
}