Sign in
Runs

Cancel a run

Cancels a run that is still queued or running, scoped to the caller's org. A run that has already reached a terminal state (completed/failed/cancelled) cannot be cancelled and reads as not found. Returns the updated run.

post/runs/{run_id}:cancel

Path parameters

run_idstring uuid required

run identifier

run identifier

Response

OK

canceled_atstring date-time

Timestamp when the run was cancelled.

completed_atstring date-time

Timestamp when the run finished.

created_atstring date-time required

Timestamp when the run record was created.

error_messagestring

Error details if the run failed.

idstring uuid required

Run identifier.

logsstring

Run's execution log output.

phone_idstring

Device executing the run.

run_metadataobject

Arbitrary metadata attached to the run.

session_idstring uuid

Session associated with this run.

start_timeout_secondsinteger

How long the queued run may wait for a phone before auto-cancel.

started_atstring date-time

Timestamp when the run began executing.

status'queued' | 'running' | 'completed' | 'failed' | 'cancelled' required

Current lifecycle state of the run.

successboolean

Whether the run completed without error.

trace_expired_atstring date-time

When the trace recording was deleted.

trigger'manual' | 'scheduled' | 'api' required

Trigger identifies how the run was initiated.

updated_atstring date-time required

Timestamp of the last update to the run record.

user_idstring uuid required

User who initiated the run.

variablesobject

Variable configuration used for the run.

video_urlstring

URL for the run recording video.

workflow_idstring uuid required

Workflow this run belongs to.

workflow_namestring

Display name of the workflow this run belongs to.

Changes