Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

id
string
required

Agent id.

Minimum string length: 1

Query Parameters

locationId
string

Pair with campaignId; omit both for primary campaign.

Minimum string length: 1
campaignId
string

Pair with locationId; omit both for primary campaign.

Minimum string length: 1

Body

application/json

At least one of campaignConfig or nodes is required.

campaignConfig
object

Campaign-level settings saved with the workflow. Documented fields cover supported campaign controls; additional keys (including dashboard editor display state) are preserved for forward-compatible options.

nodes
object

Map of nodeId to the fields to merge into that node. Existing ids only. This cannot add, remove or re-link a node.

expectedVersion
integer

The workflow version you read. If the stored version has moved on, the update is refused with 409.

Required range: x >= 0
Example:

3

Response

The updated workflow.

success
boolean
required
Example:

true

workflow
object | null
required
warnings
object[]

Everything about the graph that is worth knowing and was not worth refusing. Empty on a clean graph. Read this after a write: a 200 means the graph was stored, not that every node will do something.