Sign in

v13

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-065499150.5 KB
workflows

Update a workflow

Applies a partial update (name, platform, status, ocr_engine). Org-scoped — workflows in other orgs return 404.

put/workflows/{workflow_id}

Path parameters

workflow_idstring uuid required

workflow identifier

workflow identifier

Request body

$schemastring uri

A URL to the JSON Schema for this object.

captureboolean

Capture media this workflow's runs produce on the phone into the org's file library (default true). false disables capture for every run dispatched through the scheduler.

namestring

Updated workflow name.

ocr_engine'free' | 'premium'

Updated OCR backend selection.

platform'ios' | 'android' | 'both'

Updated target platform.

recordingboolean

Record this workflow's runs (default true). false suppresses video recording and the rolling thumbnail entirely, for every run dispatched through the scheduler.

status'ready' | 'training' | 'running'

Updated lifecycle status.

telemetryboolean

Persist telemetry spans for this workflow's runs (default true). false skips the durable trace store; the live telemetry stream still works while a run is active.

Example request

{
  "$schema": "/api/v1/WorkflowUpdateRequest.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

Example response

{
  "$schema": "/api/v1/WorkflowResponse.json"
}