Skip to main content
PATCH
Update a workflow
Minimum role required: Member

Authorizations

X-Axilio-Api-Key
string
header
required

Customer API key (axl_ prefix).

Path Parameters

workflow_id
string<uuid>
required

workflow identifier

Body

application/json

Request body for updating mutable workflow fields.

capture
boolean

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.

name
string

Updated workflow name.

ocr_engine
enum<string>

Updated OCR backend selection.

Available options:
free,
premium
platform
enum<string>

Updated target platform.

Available options:
ios,
android,
both
recording
boolean

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

status
enum<string>

Updated lifecycle status.

Available options:
ready,
training,
running
telemetry
boolean

Emit telemetry for this workflow's runs (default true). false suppresses both live frames and durable trace storage.

Response

OK

Full workflow record with embedded stats.

stats
object
required

Workflow's run statistics.

workflow
object
required

Core workflow record.