v7

latestOpenAPI 3.1.02026-08-0664219301.2 KB
Workflow nodes

Update a workflow node

Update workflow-node-owned fields for a single node. Shared resources such as email messages and audience segments should be updated through their own APIs.

post/v1/workflows/{workflowId}/nodes/{nodeId}

Request body

expectedRevisionIdstring nullable required

The workflow revision token returned by the latest workflow read or mutation. Older workflows may return null before their first revision-aware mutation; pass null back as expectedRevisionId in that case. If the token is stale, the API returns a 409 Conflict error.

Example request

{
  "payload": {
    "contactPropertyQuery": {
      "key": "firstName"
    }
  }
}

Response

Workflow node updated.

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "workflow": {
    "id": "clw1a3b5c7d9e1f3g5h7i9j1",
    "status": "Draft",
    "name": "Welcome series",
    "description": "Onboarding emails for new signups",
    "mailingListId": "clm2k8j4h6g0f8d6s4a2b0z8",
    "rootNodeId": "cln8p0q2r4s6t8u0v2w4x6z8",
    "nodes": {
      "cln8p0q2r4s6t8u0v2w4x6z8": {
        "typeName": "SignupTrigger",
        "nextNodeIds": [
          "cln1a3b5c7d9e1f3g5h7i9j1"
        ]
      },
      "cln1a3b5c7d9e1f3g5h7i9j1": {
        "typeName": "SendEmailAction",
        "nextNodeIds": [],
        "emailMessageId": "cle5f7g9h1i3j5k7l9m1n3p5",
        "subject": "Welcome to Acme!"
      }
    }
  }
}