Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
workflows

Update Workflow

Edit the workflow. Structural edits on committed-only families return 409.

patch/api/workflows/{workflow_id}/

Path parameters

workflow_idstring required

Headers

Authorizationstring required

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Request body

tasksPatchedWorkflowUpdateRequestTasksItems[]
workflow_idstring

Logical workflow family key shared across versions

versioninteger
namestring nullable
descriptionstring nullable
type'automations' | 'monitors' | 'evaluators' | 'reports' | 'exports' | 'ingests'
  • automations - Automation
  • monitors - Monitor
  • evaluators - Evaluator
  • reports - Report
  • exports - Export
  • ingests - Ingest
schedule_cronstring nullable

UTC cron schedule (5-field). Populated when trigger_event_type='scheduled'.

has_async_stepsboolean
is_starredboolean
resource_idsstring[]

All resource IDs referenced in workflow (for reverse lookup)

updated_byinteger nullable

Response

idstring required
tasksWorkflowUpdateTasksItems[]
projectstring nullable required
workflow_idstring

Logical workflow family key shared across versions

versioninteger
namestring nullable
descriptionstring nullable
unique_organization_idstring required
type'automations' | 'monitors' | 'evaluators' | 'reports' | 'exports' | 'ingests'
  • automations - Automation
  • monitors - Monitor
  • evaluators - Evaluator
  • reports - Report
  • exports - Export
  • ingests - Ingest
schedule_cronstring nullable

UTC cron schedule (5-field). Populated when trigger_event_type='scheduled'.

has_async_stepsboolean
is_enabledboolean required

Only committed (is_read_only=True) versions may be enabled. At most one version per workflow family should be enabled at a time.

is_starredboolean
is_read_onlyboolean required

True for committed versions; only the latest version is editable

resource_idsstring[]

All resource IDs referenced in workflow (for reverse lookup)

created_atstring date-time required
updated_atstring date-time required
updated_byinteger nullable