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",
  // ...other envelope properties
}

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 the 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",
  // ...other envelope properties
}