Campaigns / REST API
Create subsequence
Create a follow-up subsequence on a campaign for a given trigger type. Only one subsequence per trigger (or per custom tag) is allowed per campaign. Omit workflowDefinition to use the system default single-step workflow for the trigger.
POST /api/campaigns/{campaignId}/subsequencesDeterministic operationParameters
workspaceIdOptional · string- Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
campaignIdRequired · string- See the input schema for this field.
triggerRequired · string- What causes this subsequence to fire.interested_reply · meeting_request · no_reply · custom_tag
triggerTagOptional · string- Required when trigger is custom_tag. The inbox tag name that fires this subsequence. Cannot be a built-in pipeline tag.
nameOptional · string- See the input schema for this field.
enabledOptional · boolean- Defaults to false (disabled) unless set.
triggerConfigOptional · object- e.g. { noReplyDays: 3 } for the no_reply trigger.
workflowDefinitionOptional · object- ReactFlow-style { nodes, edges } graph of message steps with delays. Omit to use the default workflow for the trigger type.
curl -X POST "https://app.pipeline.help/api/campaigns/00000000-0000-4000-8000-000000000000/subsequences" \
-H "Authorization: Bearer $PIPELINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"trigger":"interested_reply"}'Full input schema
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1,
"description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
},
"campaignId": {
"type": "string"
},
"trigger": {
"type": "string",
"enum": [
"interested_reply",
"meeting_request",
"no_reply",
"custom_tag"
],
"description": "What causes this subsequence to fire."
},
"triggerTag": {
"type": "string",
"description": "Required when trigger is custom_tag. The inbox tag name that fires this subsequence. Cannot be a built-in pipeline tag."
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean",
"description": "Defaults to false (disabled) unless set."
},
"triggerConfig": {
"type": "object",
"additionalProperties": true,
"description": "e.g. { noReplyDays: 3 } for the no_reply trigger."
},
"workflowDefinition": {
"type": "object",
"additionalProperties": true,
"description": "ReactFlow-style { nodes, edges } graph of message steps with delays. Omit to use the default workflow for the trigger type."
}
},
"required": [
"campaignId",
"trigger"
]
}