Workflows

Update a workflow

Partially updates a workflow row.

The fields id, team_id, stage and created_at are blacklisted and silently dropped from the patch — in particular you cannot promote a draft to live this way — going live is what the planned POST /workflows does.

When the patch touches operations, updated_at is refreshed and a workflow_updated trigger is posted to the coordinator so the running schedule reloads; the outcome of that notification is reported back in trigger_notification.

The caller must belong to a team that owns the workflow, or be a site admin.

patch/workflows/{workflow_id}

Request

  • Base URL: https://api.indexone.io
  • URL: https://api.indexone.io/workflows/{workflow_id}
  • Auth: API key in header x-api-key and API key in header Authorization

Path parameters

workflow_idstring required

Workflow id.

Request body

namestring
descriptionstring
visibility'private' | 'public' | 'unlisted'

public is readable by anyone and listed in the Index Directory; unlisted is readable by anyone with the link but not listed.

operationsobject[]

The full operation DAG. Replaces the existing one wholesale.

exchange_calendarstring
timezonestring

Response

The updated workflow record (ALL_NEW), plus trigger_notification when operations changed.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.