Sequences

Get sequence condition variable catalog

Lists every path a SEQUENCE_CONDITION node's conditionGroup may reference for the given consumerNodeId (the condition node itself): [Person].[<Field>] (always available, the enrolled Person's record), [User].[First Name|Last Name|Email] (always available, the user who enrolled the Person — the sender's identity, not the actor who triggered a step), [Instance].[id|sequenceId|personRowId|status] (always available, fixed set — no engagement flags here), and [Output:<nodeId>].[<field>] / [Observation:<nodeId>].[<field>] for ancestor nodes only (Observation fields such as replied/opened/clicked/deliveryStatus exist only for SEND_EMAIL and SEND_WHATSAPP_MESSAGE ancestors). Use this instead of guessing a path — an unlisted path passes node create/update but fails at publish.

get/public/v1/sequences/{sequenceId}/variable-catalog

Path parameters

sequenceIdinteger required
Example:1

Query parameters

consumerNodeIdstring required
boolean
OR
string
Example:example

Response

Variable catalog entries

pathstring required
labelstring required
type'string' | 'number' | 'boolean' | 'date' | 'dateOnly' required
namespace'Person' | 'User' | 'Instance' | 'Output' | 'Observation' required
sourceNodeIdstring
availability'ALWAYS' | 'PATH_DEPENDENT'
optionsstring[]

Example response

[
  {
    "path": "example",
    "label": "example",
    "type": "string",
    "namespace": "Person",
    "sourceNodeId": "example",
    "availability": "ALWAYS",
    "options": [
      "example"
    ]
  }
]

Changes

Changed in 1 of the 2 revisions of this API.1