Sign in

v3

latestOpenAPI 3.0.3MIT2026-07-313881,2455.6 MB
Automation workflows

Updates an existing workflow of an automation.

patch/api/automation/workflows/{workflow_id}/

Path parameters

workflow_idinteger required

The id of the workflow.

Headers

ClientSessionIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.

Request body

namestring
allow_test_runboolean

If provided, enables the workflow to be triggerable for the next 5 minutes.

state'draft' | 'live' | 'paused' | 'disabled' | 'test_clone'
  • draft - Draft
  • live - Live
  • paused - Paused
  • disabled - Disabled
  • test_clone - Test Clone
notification_recipient_idsinteger[]

The user IDs of the workspace members that should receive notifications related to this workflow.

Response

idinteger required
namestring required
orderinteger required

Lowest first.

automation_idinteger required
allow_test_run_untilstring date-time nullable
simulate_until_node_idinteger nullable required

When set, upon the next workflow run, simulates the dispatch of the workflow until this node and updates the sample_data of the node's service.

published_onstring required
statestring required
{"stackTrail":"components:schemas:AutomationWorkflow:properties:graph","oasType":"schema","type":"unknown","description":"A JSON serialized graph containing the points and edges."}
notification_recipient_idsinteger[] required
immediate_dispatchboolean required