Skip to main content
POST
Cancel the Architect's turn
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

POST /api/v2/workflows/cancelArchitectTurn The API twin of the Architect drawer’s stop button. It asks a running or queued turn to stop at its next step; a step already running finishes first. When no turn is running it writes nothing and answers requested: false.

Authentication

Personal key, External App credential or platform API key. Requires permission workflows:write, and workflows:write and workflows:read held at the workflow’s home org unit.

Headers

string
Optional. A same-key retry within 24 hours returns the recorded answer without running again, only while the caller may still write the draft of the workflow that answer names, at that workflow’s home; otherwise 409 idempotency_result_unavailable. A replay never starts a second turn. The same key with a different body is 422. See Idempotency.

Body

string
required
The workflow ID.

Responses

200 with data.workflowId, data.draftId and data.requested. After a stop is requested, listArchitectMessages shows turn.state: "stopping" until the turn ends.

Errors

Example

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

workflowId
string
required

The workflow id.

Minimum string length: 1

Response

Cancel the Architect's turn

data
object
required
meta
object
required