POST
/
v1
/
envelopes
/
{envelope_id}
/
cancel
// POST https://api.signatureapi.com/v1/envelopes/{envelope_id}/cancel
// X-API-Key: key_test_...
{
  "reason": "Price renegotiated by John D."
}

{
  "id": "55072f0e-b919-4d69-89cd-e7e56af00530",
  "title": "Dummy Agreement",
  "status": "canceled",
  // ...other envelope properties
}
This action is irreversible and permanent.
Available only for envelopes with status in_progress.

​
Path Parameters

​
envelope_id
uuid
required

The unique identifier of the envelope.

​
Body Parameters

​
reason
string

An explanation for the envelope’s cancellation. This is for internal use and not shown to recipients.

​
Returns

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

// POST https://api.signatureapi.com/v1/envelopes/{envelope_id}/cancel
// X-API-Key: key_test_...
{
  "reason": "Price renegotiated by John D."
}

{
  "id": "55072f0e-b919-4d69-89cd-e7e56af00530",
  "title": "Dummy Agreement",
  "status": "canceled",
  // ...other envelope properties
}