Skip to main content
POST https://api.craftkit.dev/v1/signatures/:id/cancel
Cancels an in-flight request with the signature service and marks it cancelled. Rejected with 409 when the request is already in a terminal state (completed, declined, expired, cancelled, or failed).

Authorization

string
required
Bearer ck_live_… — a project API key.

Path parameters

string
required
The signature request id (UUID).

Body

The body is optional — an empty body is accepted.
string
Cancellation reason (≤500 chars). Stored on the request as errorMessage.

Response

The updated signature request (same shape as the create response), now with status: "cancelled".
string
string
cancelled after a successful cancel.
string | null
The supplied reason, if any.
string | null

Errors

cURL
200