> ## Documentation Index
> Fetch the complete documentation index at: https://signatureapi-daf4ee54.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel an envelope

> Cancel an in-progress envelope to permanently halt the signing process

Cancels an envelope, immediately halting all signing activity. Once canceled, recipients can no longer access the signing ceremony.

<Warning>This action is irreversible and permanent.</Warning>

<Note>Only envelopes with status `in_progress` can be canceled.</Note>

## Path parameters

<ParamField path="envelope_id" type="uuid" required={true}>
  The unique identifier of the envelope, in UUID format.
</ParamField>

## Body parameters

<ParamField body="reason" type="string" required={false}>
  An optional explanation for why the envelope was canceled. This is for internal use only and is not shown to recipients. The reason is included in the `envelope.canceled` webhook event payload. Maximum 2,000 characters.
</ParamField>

## Returns

Returns a `200 OK` status code along with [an envelope object](/docs/api/resources/envelopes/object) on success, or an [error](/docs/api/errors) otherwise.

<RequestExample>
  ```json Request theme={null}
  // POST https://api.signatureapi.com/v1/envelopes/{envelope_id}/cancel
  // X-API-Key: key_test_...
  // Content-Type: application/json

  {
    "reason": "Price renegotiated by John D."
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  // HTTP Status Code 200

  {
    "id": "55072f0e-b919-4d69-89cd-e7e56af00530",
    "title": "Exploration Agreement",
    "status": "canceled",
    //...
  }
  ```
</ResponseExample>