Add actions to an outcome

The normal way to add steps. Append one or more nodes to the end of an outcome’s action chain. Prefer this over the whole-graph PUT for ordinary edits. You describe what should happen; the server derives the node ids, the edge ids, the branch handles and the canvas coordinates, which are the parts the PUT expects you to invent correctly.

Applied atomically: if any node in the list is rejected, nothing is written. Appending an action the chain already performs is a no-op rather than a duplicate, so a retry is safe.

Each entry is discriminated on type. Most types are { type, config }. A switch router is { type: "switch", cases: [{ condition, actions }], default } because one router produces a branch node plus a chain per case.

Unlike the PUT, per-node config IS required here — an action you are adding on purpose should be complete. Use the PUT if you want to save an unconfigured draft. A chain that already ends in a branch cannot be appended to; edit it in the builder.

Send an Idempotency-Key header if you may retry. This is the only operation here that creates, so a request that timed out is genuinely ambiguous. A repeat with the same key and the same body returns the original result instead of appending again; a repeat with the same key and a different body is rejected with 409.

Required API key scope: campaign_workflows:write.

POST /api/agent-builder/agents/{id}/campaign/workflow/outcomes/{outcome}/nodes

cURL

cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/workflow/outcomes/{outcome}/nodes \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "nodes": [
    {
      "type": "add-tag",
      "config": {
        "tags": [
          "booked_via_ai"
        ]
      }
    },
    {
      "type": "send-sms",
      "config": {
        "message": "Thanks for booking! See you soon."
      }
    }
  ]
}'

200

{
  "success": true,
  "workflow": {
    "locationId": "loc_abc123",
    "campaignId": "cmp_123",
    "campaignConfig": {
      "callbackMode": "ai"
    },
    "nodes": {
      "tag_booked": {
        "id": "tag_booked",
        "type": "add-tag",
        "config": {
          "tags": [
            "booked_via_ai"
          ]
        }
      },
      "sms_reminder": {
        "id": "sms_reminder",
        "type": "send-sms",
        "config": {
          "message": "Thanks for booking! See you soon."
        }
      }
    },
    "edges": [
      {
        "id": "e_booked",
        "source": "tag_booked",
        "target": "sms_reminder"
      }
    ],
    "dispositionEntries": {
      "SUCCESS": "tag_booked"
    },
    "version": 3,
    "createdAt": "2026-07-01T09:15:22.000Z",
    "updatedAt": "2026-07-14T16:04:11.000Z"
  }
}

Authorizations

Authorization · string · header · required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Headers

Idempotency-Key · string

Optional retry key for create-style operations. Reusing the same key with the same request returns the original result; reusing it with a different request returns 409.

Required string length: 1 - 255

Path Parameters

id · string · required

Agent id.

Minimum string length: 1

outcome · string · required

The call outcome whose chain to append to. Accepts the raw disposition (SUCCESS), any case (success), or the label the dashboard shows (On callback). Rejected with 400 if the agent's type can never emit it — see dispositions from GET /api/v2/projects/systems.

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

Request payload. Detailed schema pending — see the route handler.

nodes · object[] · required

Appended in order to the end of the outcome chain, as one atomic write.

Minimum array length: 1

A router to add. One router produces a branch node plus a linear chain per case, which is why the cases carry their own actions rather than being wired separately.

Option 1

Option 2

Show child attributes

expectedVersion · integer

Optimistic-concurrency guard: rejected with 409 if the stored version has moved on.

Required range: x >= 0

Example:

3

{key} · any

Response

200

application/json

The updated workflow.

success · boolean · required

Example:

true

workflow · object | null · required

Show child attributes

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.

Show child attributes