Skip to main content
POST
Stop private setup through a message

Authorizations

Authorization
string
header
required

Send a dashboard session token, an account API key (agt_t), or a command-line credential (afc_) as a Bearer token. Each endpoint lists accepted credential types.

Path Parameters

workspace_id
string
required

Workspace identifier (version 7 universally unique identifier, or UUID).

draft_id
string
required

Draft identifier (version 7 universally unique identifier, or UUID).

Body

application/json

Stops work through the supplied accepted user-message sequence.

through_sequence
string
required

Nonnegative decimal string; a future sequence is refused.

Response

Standing cutoff and newly cancelled requests

Cancellation result, including the latest cancelled message sequence and newly cancelled requests.

cancelled_through
string
required

Highest cancelled message sequence, as a decimal string.

stopped
object[]
required

Newly transitioned requests.