The identity and technical contract details declared by the specification.
BlankTriggerWorkflowNode
object
4 properties
4 required
AddToListTriggerWorkflowMutationNodeWithRevision
WorkflowTimerActionPayload
object
Configuration for the timer action node.
2 properties
CreateWorkflowNodeBetweenRequest
object
Insert a new node between two existing nodes, fromNodeId and toNodeId. When fromNodeId is an ExperimentBranchNode, nodeTypeName must be VariantNode, and toNode…
5 properties
5 required
VariantWorkflowMutationNodeWithRevision
SimplifiedSendEmailActionWorkflowNode
object
4 properties
4 required
CreateWorkflowNodeAfterRequest
object
Insert a new node after fromNodeId. This is valid only when fromNodeId has exactly one outgoing node. It is invalid when fromNodeId has no outgoing nodes, mult…
4 properties
4 required
ExitActionWorkflowMutationNode
object
3 properties
3 required
AddWorkflowBranchResponse
object
2 properties
2 required
UpdateWorkflowNodeResponse
The updated workflow node, plus the latest simplified workflow.
SignupTriggerWorkflowMutationNode
object
3 properties
3 required
WorkflowMutationNodeRevision
object
1 property
1 required
WorkflowContactPropertyQuery
object
Define the contact property change that triggers the workflow. In update requests, key must resolve to an existing contact property that is available for Conta…
3 properties
3 required
ExperimentBranchWorkflowMutationNode
object
4 properties
4 required
WorkflowContactPropertyComparison
object
For Contact Updated triggers, the API validates operator against the selected contact property's type and the side of the comparison. The was comparison can us…
2 properties
2 required
WorkflowEventTriggerPayload
object
Updates an event trigger, or changes an existing trigger node to an event trigger. Assign the event pattern with either eventPatternId or eventName, not both.…
4 properties
CreateWorkflowNodeRequest
Create a new workflow node with an explicit insertMode. To configure the node after creation, use the POST /v1/workflows/{workflowId}/nodes/{nodeId} endpoint.
SendEmailActionWorkflowMutationNodeWithRevision
WorkflowAddToListTriggerPayload
object
Updates an add-to-list trigger, or changes an existing trigger node to an add-to-list trigger.
2 properties
TimerActionWorkflowMutationNodeWithRevision
RerouteNodeConnectionRequest
object
Reroute the source node's only outgoing connection to newTargetNodeId.
2 properties
2 required
TimerActionWorkflowNode
object
6 properties
6 required
ActivityCondition
object
Matches contacts by their activity on a campaign or workflow.
5 properties
5 required
OptInCondition
object
Matches contacts by mailing-list opt-in status.
2 properties
2 required
AudienceFilterWorkflowMutationNode
object
6 properties
4 required
NullableWorkflowRevisionId
stringnull
The current workflow revision token. Pass the latest value as expectedRevisionId on the next workflow mutation. Will be null for workflows without a revision t…
EventTriggerWorkflowNode
object
7 properties
5 required
AddWorkflowBranchRequest
object
1 property
1 required
BlankTriggerWorkflowMutationNodeWithRevision
WorkflowQueuedContactPolicy
string
fail returns queued-contact impact instead of mutating. discard confirms that matching queued contacts should be discarded. Defaults to fail when omitted.
ContactPropertyTriggerWorkflowMutationNodeWithRevision
VariantWorkflowNode
object
5 properties
4 required
BranchWorkflowMutationNode
object
3 properties
3 required
WorkflowDeletedResponse
object
5 properties
5 required
SimplifiedContactPropertyTriggerWorkflowNode
object
4 properties
4 required
PropertyCondition
object
Matches contacts by a property value.
4 properties
3 required
CreateWorkflowNodeBeforeRequest
object
Insert a new node before toNodeId. VariantNode cannot use insertMode: "before"; to restore a missing variant path, use insertMode: "between" with the experimen…
5 properties
3 required
WorkflowSignupTriggerPayload
object
Changes an existing trigger node to a signup trigger.
1 property
1 required
SimplifiedWorkflow
object
8 properties
6 required
UpdateWorkflowNodeRequest
object
2 properties
2 required
SimplifiedVariantWorkflowNode
object
3 properties
3 required
BranchWorkflowMutationNodeWithRevision
SimplifiedAudienceFilterWorkflowNode
object
2 properties
2 required
CreateWorkflowNodeResponse
object
2 properties
2 required
ContactPropertyTriggerWorkflowNode
object
6 properties
6 required
DeleteWorkflowNodeRequest
object
3 properties
1 required
WorkflowRevisionId
string
The current workflow revision token. Pass the latest value as expectedRevisionId on the next workflow mutation.
AudienceFilterWorkflowMutationNodeWithRevision
SignupTriggerWorkflowMutationNodeWithRevision
WorkflowTimerAmount
number
The amount of time to wait before triggering the next node. Set to 0 to move to the next node immediately.
SimplifiedSignupTriggerWorkflowNode
object
2 properties
2 required
SimplifiedExperimentBranchWorkflowNode
object
3 properties
3 required
SimplifiedEventTriggerWorkflowNode
object
4 properties
4 required
SimplifiedTimerActionWorkflowNode
object
4 properties
4 required
SignupTriggerWorkflowNode
object
4 properties
4 required
BranchWorkflowNode
object
4 properties
4 required
AudienceFilterWorkflowNode
object
7 properties
5 required
UpdateWorkflowNodePayload
Node-type-specific fields to update. The allowed fields depend on the existing node type. Trigger node updates may include typeName when changing one trigger n…
SimplifiedAddToListTriggerWorkflowNode
object
4 properties
4 required
WorkflowAudienceFilterPayload
object
Configuration for the audience filter node.
3 properties
EventTriggerWorkflowMutationNode
object
6 properties
4 required
WorkflowFailureResponse
object
1 property
1 required
BlankTriggerWorkflowMutationNode
object
3 properties
3 required
WorkflowReEligible
boolean
If true, the contacts will be able to enter this workflow every time the trigger is matched. If false, contacts will only ever enter this workflow once. Matche…
AddToListTriggerWorkflowMutationNode
object
5 properties
5 required
AudienceFilter
objectnull
A tree of audience conditions combined with match.
2 properties
2 required
AudienceFilterInRequest
objectnull
A tree of audience conditions combined with match. Setting this without also providing audienceSegmentId clears any existing audienceSegmentId. When both are p…
2 properties
2 required
RerouteNodeConnectionResponse
The updated source node, plus the latest workflow.
WorkflowContactPropertyTriggerPayload
object
Updates a contact-property trigger, or changes an existing trigger node to a contact-property trigger.
3 properties
SimplifiedBranchWorkflowNode
object
2 properties
2 required
WorkflowTimerUnit
string
The unit of time for the timer action node. m = minutes, h = hours, d = days.
AddToListTriggerWorkflowNode
object
6 properties
6 required
ContactPropertyTriggerWorkflowMutationNode
object
5 properties
5 required
EventTriggerWorkflowMutationNodeWithRevision
CreateWorkflowNodeTypeName
string
Node types that can be created with the API. Trigger nodes and ExitAction nodes cannot be created.
WorkflowMutationNode
Detailed workflow node returned from create and update mutations. The exact fields depend on typeName.
ExitActionWorkflowNode
object
4 properties
4 required
ExperimentBranchWorkflowMutationNodeWithRevision
TimerActionWorkflowMutationNode
object
5 properties
5 required
WorkflowVariantPayload
object
Configuration for the variant node.
1 property
WorkflowExperimentBranchPayload
object
Configuration for the experiment branch node.
1 property
SendEmailActionWorkflowMutationNode
object
5 properties
5 required
VariantWorkflowMutationNode
object
4 properties
3 required
WorkflowQueuedContactDeletePreview
object
3 properties
3 required
WorkflowMutationNodeWithRevision
Detailed workflow node returned from a mutation, plus the latest workflow revision token.
SimplifiedExitActionWorkflowNode
object
2 properties
2 required
WorkflowExpectedRevisionId
stringnull
The workflow revision token returned by the latest workflow read or mutation. Older workflows may return null before their first revision-aware mutation; pass…
DeleteWorkflowNodeResponse
ExitActionWorkflowMutationNodeWithRevision
SendEmailActionWorkflowNode
object
6 properties
6 required
SimplifiedBlankTriggerWorkflowNode
object
2 properties
2 required
WorkflowEventProperty
object
2 properties
2 required
WorkflowNodeWithRevision
Detailed workflow node returned from read operations. The exact fields depend on typeName.
ExperimentBranchWorkflowNode
object
5 properties
5 required
WorkflowNextNodeIds
array
The IDs of the nodes that are downstream of this node.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Loops publishes across the network.
