Workflows

Update a workflow

Sparse update — omitted fields are left unchanged.

Two state rules apply: the trigger (trigger_type/event_name/interval_ms) cannot be changed while the workflow has running executions (409), and enabled: true is refused while any step is still unconfigured (422), because an enabled workflow accepts contacts immediately and would otherwise fail only once one reached the broken step.

sequence REPLACES every non-trigger step with a linear chain and is likewise refused while executions are running. Omit it to leave the graph untouched.

Requires the workflows:write scope — Create, edit, enable, and delete your automation workflows.

patch/api/v1/workflows/{id}

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/workflows/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: workflows:write)

Path parameters

idstring uuid required

Workflow id.

Request body

allow_reentryboolean
descriptionstring
enabledboolean
event_namestring
interval_msinteger

For SCHEDULE workflows: how often the workflow fires, in milliseconds. Between one minute and 30 days; defaults to one hour.

max_executions_per_hourinteger nullable

Per-workflow start rate cap. null removes the cap.

namestring
trigger_type'EVENT' | 'MANUAL' | 'SCHEDULE'

What starts a workflow. EVENT: a custom event you record. MANUAL: only an explicit API call. SCHEDULE: a fixed repeating interval.

Response

Updated workflow

allow_reentryboolean required
created_atstring date-time required
descriptionstring nullable required
enabledboolean required
event_namestring nullable required

Trigger event for EVENT workflows; null for the other trigger types.

idstring uuid required
max_executions_per_hourinteger nullable required
namestring required
step_countinteger required

Steps in this workflow's graph, trigger step included — so a workflow that has only ever been created reports 1. Read /graph for the steps themselves.

trigger_type'EVENT' | 'MANUAL' | 'SCHEDULE' required
updated_atstring date-time required
versioninteger required

Incremented on every structural (step/transition) change.

Changes

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