Cancel a run

POST

/projects/:projectId/playbook-runs/:runId/cancel

Cancels a playbook run; requires a cancellation reason.

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

projectIdstringRequired

runIdstringRequired

The cancelled run.

runmap from strings to any

A playbook run projection.

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

1	curl -X POST https:/https://api/projects/projectId/playbook-runs/runId/cancel \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"reason": "Duplicate run initiated by mistake"
6	}'

1	{
2	"run": {
3	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef56gh78",
4	"projectId": "proj-1234567890",
5	"status": "cancelled",
6	"cancelledAt": "2024-06-10T15:45:00Z",
7	"cancelReason": "Duplicate run initiated by mistake",
8	"startedAt": "2024-06-10T14:00:00Z",
9	"endedAt": "2024-06-10T15:45:00Z",
10	"owner": "user_987654321",
11	"summary": "Playbook run cancelled due to duplicate execution"
12	}
13	}