Update Workflow
Updates a workflow. Only the fields present in changes are written, so omitted keys stay as they are.
Authorization
Authorization In: header
Path Parameters
ID of the project that owns the workflow.
ID of the workflow to update.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Fields to change. Anything omitted is left as-is.
Audience filter groups. A contact must match at least one group to enter the workflow.
Attribute conditions, combined with oneDayEventFilters by groupType.
Contact attribute distinct id to filter on.
Attribute type. Defaults to string when omitted.
Comparison operator for the attribute value.
Value to compare the attribute against.
Event conditions over a rolling 24 hour window (not configurable). Each one is a condition in the group alongside filters, so AND, OR, and NOT apply to both. Used the same way by CRM lists, campaign audiences, workflow entry filters, and Audience Filter steps.
Analytics event name from analytics_queryEvents with groupBy action, or Sent email, Delivered email, Opened email, Clicked email, Bounced email, Complained email, or Suppressed email. Those seven read email activity for the same 24 hour window, not analytics.
performed: the contact has at least one event with this name in the last 24 hours. notPerformed: a contact in the project with no such event in the last 24 hours, including contacts with no events at all.
How the conditions in filters and oneDayEventFilters combine: AND all true, OR any true, NOT none true.
When true, the group is ANDed with $subscribed == true. Set by email sending, not the filter UI.
When true, the group is ANDed with $emailValidated != true. Set by email validation, not the filter UI. The user's AND, OR, and NOT are unchanged.
ONCE runs a contact through at most once. EVERY re-enters them each time the trigger fires, subject to maxRuns and minDelay.
Maximum times a contact can go through this workflow. Null means no cap.
Minimum delay between runs for the same contact. Pair with minDelayUnit.
Unit for minDelayAmount: MINUTES, HOURS, or DAYS.
Display name of the workflow.
INACTIVE, PAUSED, or ACTIVE.
Name of the analytics event that starts a run, e.g. signup.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/projects/string/workflows/string" \ -H "Content-Type: application/json" \ -d '{ "changes": {} }'{ "id": "string", "createdAt": "string", "updatedAt": "string", "name": "string", "projectId": "string", "triggerEvent": "string", "maxRuns": -9007199254740991, "minDelayAmount": 5, "minDelayUnit": "MINUTES", "frequency": "ONCE", "status": "INACTIVE", "contactsFilterGroups": [ { "filters": [ { "attributeDistinctId": "string", "attributeType": "string", "operator": "equals", "value": "string" } ], "oneDayEventFilters": [ { "eventName": "string", "operator": "performed" } ], "groupType": "AND", "requireSubscribed": true, "requireUnvalidatedEmail": true } ]}Create Workflow
Creates a workflow definition: the trigger event, audience filters, frequency, and delay between runs. Creating one never starts a run and never sends anything. Optional templateId (welcome-series, trial-nurture, re-engagement) also creates connected steps and editable draft emails in one transaction; template workflows always start INACTIVE. Without a template, steps and edges are added separately.
Delete Workflow
Permanently deletes a workflow and everything cascading from it: steps, edges, runs, and run logs. Cannot be undone.