WorkflowsVersion: v3

Validate Workflow Definition

POST/workflows/definition/validate

Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.

Run the full save pipeline against a definition and report what a real save would do. Nothing is persisted. Returns 200 with valid: false when the definition is rejected — a 4xx here means the request itself was malformed.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:workflows.write

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version. Send v3.

Available optionsv3

Example:v3

Query Parameters

locationIdstringrequired

Sub-account (location) ID the workflow belongs to

Example:ve9EPM428h8vShlRW1KT

Body

application/json

namestringrequired

Workflow name

Possible values: <= 500 characters

Example:Welcome series

sourceobjectrequired

Where this definition came from

triggersobject[]required

Triggers that enrol contacts. May be empty — a workflow with no trigger can still be entered by another workflow or by the API — but the key must be present.

triggers[].typestringrequired

Trigger type key

Example:contact_created

triggers[].namestring

Display name shown on the canvas

Example:New contact

triggers[].conditionsobject[]

Trigger filters. Shape depends on type; use Validate Workflow Definition to check it.

Example:[]

triggers[].scheduleConfigobject

Schedule for scheduler-type triggers. Absent on every other trigger type. Get Workflow Definition returns it in this shape and Update Workflow Definition accepts it back.

triggers[].idstring

Trigger ID. Assigned when omitted. Get Workflow Definition returns it; sending it back keeps the trigger stable across updates.

Possible values: <= 200 characters

Example:7c1f0d2e-3b4a-4c5d-8e9f-0a1b2c3d4e5f

triggers[].positionobject

Canvas position, as the builder stores it. Echoed by Get Workflow Definition; optional on write.

triggers[].testResponseobject

Sample event captured by the builder for testing the trigger. Passed through verbatim.

triggers[].metadataobject

Importer bookkeeping. Passed through verbatim.

triggers[].workflowsTriggerTypestring

Marketplace (IATF) triggers only: the trigger class the app registered. Echoed by Get Workflow Definition; send it back unchanged.

Example:INTERNAL

triggers[].integrationAccountIdstring

Marketplace (IATF) triggers only: the connected account the trigger listens on.

Example:acct_01HZX3K9P2Q

triggers[].masterTypestring

Trigger family, as the builder stores it.

Example:internal

triggers[].targetActionIdstring

For triggers bound to one step (a reply trigger, for example), the ID of that step.

Example:welcome-sms

triggerRelationstring

How multiple triggers combine. Echoed by Get Workflow Definition; ignored on write — the system always stores or.

Available optionsandor

Example:or

actionsobject[]required

Steps. May be an empty array, but the key must be present.

actions[].idstringrequired

Step ID. Any non-empty string, unique within the definition — a readable id like welcome-sms is fine, and edges reference it by that name. It does not have to be a UUID; ids that are not get converted to one when the workflow is saved, so a definition read back will carry the converted ids rather than the ones sent.

Reuse ids across updates. A step keeps contacts already mid-workflow on their current step only while it keeps its id. Sending back the ids from Get Workflow Definition is the reliable way to do that — a readable id also converts to the same value every time for a given workflow, so re-sending an authored definition is safe too.

Possible values: <= 200 characters

Example:welcome-sms

actions[].typestringrequired

Step type key

Example:add_contact_tag

actions[].namestring

Display name shown on the canvas

Example:Tag as lead

actions[].attributesobject

Step configuration. The shape depends on type — fetch it from Get Step Types and check it with Validate Workflow Definition.

actions[].positionobject

Canvas position, as the builder stores it. Echoed by Get Workflow Definition; optional on write.

actions[].metadataobject

Importer bookkeeping. Passed through verbatim.

actions[].workflowsActionTypestring

Marketplace (IATF) steps only: the action class the app registered. Echoed by Get Workflow Definition; send it back unchanged.

Example:INTEGRATION

actions[].isMarketplaceActionboolean

Marketplace (IATF) steps only: marks the step as a marketplace action.

Example:true

actions[].containerstring

ID of the container step this step is nested in, where the builder uses one.

Example:loop-1

edgesobject[]required

Connections between steps. May be empty, but the key must be present.

settingsobject

Workflow-level settings

folderNamestring

Single-segment folder to place the workflow in. Mutually exclusive with folderPath.

Example:Sales

folderPathstring[]

Folder path, outermost first, max 10 levels. Mutually exclusive with folderName.

Example:["Sales","Q3"]

createFolderIfMissingboolean

Create the folder if it does not exist. Requires folderName or folderPath.

Example:true

versionnumber

The workflow's version counter, owned by the system — not a format version. Get Workflow Definition fills it in; leave it untouched and send it back on update, and a concurrent edit in the builder can never be silently overwritten. A stale value is rejected with 422.

Treat it as opaque: echo it, never compute from it. It does not always advance by one (delete and restore each add 0.1, and a later save rounds up), so it is not always an integer.

Optional here: a create-shaped definition has no counter yet.

Example:3

workflowIdstring

Validate as an update of this workflow rather than as a create. 404 if it does not exist.

Example:b1b0de82-3efb-4d63-83f6-13c50aef208c

Response

application/json

Validation result

validbooleanrequired

Whether this exact body would save right now. false is still a 200.

Example:false

errorsobject[]required

Blocking findings

warningsobject[]required

Non-blocking findings