---
title: "Cancel a Workflow"
method: POST
path: "/workflows/{id}/cancel"
tags: ["Workflows"]
---

# Cancel a Workflow

`POST /workflows/{id}/cancel`

Cancel a workflow. 

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

## Path parameters

- `id` string, required

## Headers

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

## Request body

- object
  - `comment` CommentModel, required
    - `message` string, required — The comment text to add, accepts user mentions in the form of <@user_id_or_email>.
    - `addUsersToWorkflow` boolean — Must be set to true if mentioning users who are not participants on the workflow.

## Response `204`

204

- object

---

[API](https://skmtc.net/ironcladapp/apis/ironclad-public-api.md) · [All operations](https://skmtc.net/ironcladapp/apis/ironclad-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ironcladapp/ironclad-public-api/versions/9459b4cfc1e0/schema)
