---
title: "Cancel Signature Request"
method: POST
path: "/workflows/{id}/sign-status/cancel-signature-request"
tags: ["Workflows"]
---

# Cancel Signature Request

`POST /workflows/{id}/sign-status/cancel-signature-request`

## Request

- Base URL: `https://ironcladapp.com/public/api/v1`
- URL: `https://ironcladapp.com/public/api/v1/workflows/{id}/sign-status/cancel-signature-request`
- Auth: API key in header `Authorization` and OAuth 2
  - Authorization code: `https://ironcladapp.com/oauth/authorize`
  - Client credentials
  - Token URL: `https://ironcladapp.com/oauth/token` scopes: `public.workflows.cancelSignatureRequests`

Cancel a signature request that was out for signature.

**OAuth Scope required:** `public.workflows.cancelSignatureRequests`

## Path parameters

- `id` string, required

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Request body

- object
  - `reason` string, required: The reason for canceling the signature request.
  - `muteCancellationNotifications` boolean: When true, the eSignature provider does not email signers to tell them the request was canceled. Only supported for Ironclad Signature and Adobe Sign: DocuSign cannot suppress cancellation emails, and Dropbox Sign does not send one. Returns a 400 `INVALID_PARAM` error when set to true and the provider holding the in-flight request does not support it. Ignored when no request is out for signature.

## Response `200`

200

- SignStatusModel
  - `signers` union[]: All signers associated with the workflow.
    - union
      - SignStatusInternalSigner
        - `name` string, required: The signer's name.
        - `email` string, required: The signer's email.
        - `roleName` string, required: The role name associated with the signer.
        - `status` 'pending' | 'declined' | 'sent' | 'viewed' | 'signed', required: The status of the signer's action on the request.
        - `isWetSigned` boolean: Indicates if the document was physically signed by the signer and then uploaded.
        - `delegates` object[]
          - `name` string: The delegate's name.
          - `email` string: The delegate's email.
        - `routingOrder` integer: Indicates the order in which a signer signs when signing is sequential. NOTE: If a signer signs with wet signature, their routing order is denoted as -1.
        - `signsOutsideIronclad` boolean: Indicates whether this signer signs outside of Ironclad. When true, the signer is excluded from the eSignature request and the workflow waits for their signature to be uploaded.
        - `type` 'internal', required: Indicates an internal Ironclad user.
        - `userId` string: The user ID associated with the signer.
      - SignStatusExternalSigner
        - `name` string, required: The signer's name.
        - `email` string, required: The signer's email.
        - `roleName` string, required: The role name associated with the signer.
        - `status` 'pending' | 'declined' | 'sent' | 'viewed' | 'signed', required: The status of the signer's action on the request.
        - `isWetSigned` boolean: Indicates if the document was physically signed by the signer and then uploaded.
        - `delegates` object[]
          - `name` string: The delegate's name.
          - `email` string: The delegate's email.
        - `routingOrder` integer: Indicates the order in which a signer signs when signing is sequential. NOTE: If a signer signs with wet signature, their routing order is denoted as -1.
        - `signsOutsideIronclad` boolean: Indicates whether this signer signs outside of Ironclad. When true, the signer is excluded from the eSignature request and the workflow waits for their signature to be uploaded.
        - `type` 'external', required: Indicates an external signer.
  - `routing` 'sequential' | 'parallel': Indicates if routing is sequential (signatures collected in order) or parallel (all signers receive request simultaneously).
  - `status` 'not_sent' | 'sent' | 'action_required' | 'complete': Indicates the status of the signature request. NOTE: If status is 'action_required,' that means signature tags are missing for document.
  - `requireSignedDocumentUpload` boolean: Indicates if the document requires a signed document to be uploaded.
  - `provider` 'Ironclad Clickwrap' | 'Ironclad Signature' | 'Ironclad Signature (Legacy)' | 'DocuSign' | 'Adobe Sign' | 'DropboxSign' | 'Custom Provider' | 'Demo' | 'None': Indicates the signature provider used for the signature request, if any.
  - `scheduledSend` object: Present when a signature request is scheduled. Only returned when status is not_sent.
    - `notifyAt` string, date-time, required: The ISO8601 timestamp for when the signature request is scheduled to be sent.
    - `reminder` object: Reminder configuration, if set.
      - `daysBefore` integer, required: Number of days before the scheduled send when the reminder email will be sent.
      - `reminderDate` string, date-time, required: The computed ISO8601 timestamp when the reminder email will be sent.

## Other responses

- `400`: 400
- `401`: 401
- `404`: 404 not found

## Changes

- **2026-11-03** `435da5a4396e`: 1 warning, 3 info
  - added the new `Custom Provider` enum value to the `provider` response property for the response status `200`
  - added the new optional request property `muteCancellationNotifications`
  - added the optional property `signers/items/oneOf[subschema #1: Sign Status Internal Signer]/allOf[subschema #1: Base Sign Status Signer]/signsOutsideIronclad` to the response with the `200` status
  - added the optional property `signers/items/oneOf[subschema #2: Sign Status External Signer]/allOf[subschema #1: Base Sign Status Signer]/signsOutsideIronclad` to the response with the `200` status

[Operation history](https://skmtc.dev/ironcladapp/apis/ironclad-public-api/changes/workflows/:id/sign-status/cancel-signature-request/post.md)

---

[API](https://skmtc.dev/ironcladapp/apis/ironclad-public-api.md) - [All operations](https://skmtc.dev/ironcladapp/apis/ironclad-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ironcladapp/apis/ironclad-public-api/revisions/435da5a4396e?raw)