API Reference
PUT /api/admin/journeys/
API Reference
- POSTPOST /api/public/apps/identify
- POSTPOST /api/public/apps/track
- POSTPOST /api/public/apps/page
- POSTPOST /api/public/apps/screen
- POSTPOST /api/public/apps/group
- POSTPOST /api/public/apps/batch
- POSTPOST /api/public/webhooks/segment
- GETGET /api/admin/content/templates
- PUTPUT /api/admin/content/templates
- DELDELETE /api/admin/content/templates
- GETGET /api/admin/segments/
- PUTPUT /api/admin/segments/
- DELDELETE /api/admin/segments/
- GETGET /api/admin/user-properties/
- PUTPUT /api/admin/user-properties/
- DELDELETE /api/admin/user-properties/
- GETGET /api/admin/journeys/
- PUTPUT /api/admin/journeys/
- DELDELETE /api/admin/journeys/
- PUTPUT /api/public/subscription-management/user-subscriptions
- GETGet /api/admin/users/subscriptions
- POSTPOST /api/admin/users/
- DELDELETE /api/admin/users/
- GETGET /api/admin/events/
- POSTPOST /api/admin/broadcasts/execute
- PUTPUT /api-l/admin/workspaces/child
- DELDELETE /api-l/admin/workspaces
- GETGET /api-l/admin/workspaces/
- POSTPOST /api-l/sessions/
- GETGET /api/admin/groups/user-groups
- GETGET /api/admin/groups/users
API Reference
PUT /api/admin/journeys/
Create or update a journey.
PUT
/
api
/
admin
/
journeys
curl --request PUT \
--url http://localhost:3001/api/admin/journeys/ \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"canRunMultiple": true,
"updatedAt": 123,
"definition": {
"entryNode": {
"type": "EntryNode",
"segment": "<string>",
"child": "<string>",
"reEnter": true
},
"exitNode": {
"type": "ExitNode"
},
"nodes": [
{
"id": "<string>",
"type": "DelayNode",
"variant": {
"type": "Second",
"seconds": 123
},
"child": "<string>"
}
]
},
"status": "NotStarted",
"draft": {
"nodes": [
{
"id": "<string>",
"data": {
"type": "JourneyUiNodeDefinitionProps",
"nodeTypeProps": {
"type": "EntryUiNode",
"variant": {
"segment": "<string>",
"child": "<string>",
"reEnter": true,
"type": "EntryNode"
}
}
}
}
],
"edges": [
{
"source": "<string>",
"target": "<string>",
"data": {
"type": "JourneyUiDefinitionEdgeProps",
"disableMarker": true
}
}
]
}
}'
{
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"canRunMultiple": true,
"updatedAt": 123,
"draft": {
"nodes": [
{
"id": "<string>",
"data": {
"type": "JourneyUiNodeDefinitionProps",
"nodeTypeProps": {
"type": "EntryUiNode",
"variant": {
"segment": "<string>",
"child": "<string>",
"reEnter": true,
"type": "EntryNode"
}
}
}
}
],
"edges": [
{
"source": "<string>",
"target": "<string>",
"data": {
"type": "JourneyUiDefinitionEdgeProps",
"disableMarker": true
}
}
]
},
"status": "NotStarted",
"definition": {
"entryNode": {
"type": "EntryNode",
"segment": "<string>",
"child": "<string>",
"reEnter": true
},
"exitNode": {
"type": "ExitNode"
},
"nodes": [
{
"id": "<string>",
"type": "DelayNode",
"variant": {
"type": "Second",
"seconds": 123
},
"child": "<string>"
}
]
},
"createdAt": 123
}
Body
application/json
Defines when a user exits a journey. Allows users to re-enter the journey, under some set of conditions.
Available options:
ExitNode
Delays a users progression through the journey for either a set amount of time, or until a specific date time.
Available options:
DelayNode
Available options:
NotStarted
Response
200
application/json
Default Response
Available options:
NotStarted
Defines when a user exits a journey. Allows users to re-enter the journey, under some set of conditions.
Available options:
ExitNode
Delays a users progression through the journey for either a set amount of time, or until a specific date time.
Available options:
DelayNode
curl --request PUT \
--url http://localhost:3001/api/admin/journeys/ \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"canRunMultiple": true,
"updatedAt": 123,
"definition": {
"entryNode": {
"type": "EntryNode",
"segment": "<string>",
"child": "<string>",
"reEnter": true
},
"exitNode": {
"type": "ExitNode"
},
"nodes": [
{
"id": "<string>",
"type": "DelayNode",
"variant": {
"type": "Second",
"seconds": 123
},
"child": "<string>"
}
]
},
"status": "NotStarted",
"draft": {
"nodes": [
{
"id": "<string>",
"data": {
"type": "JourneyUiNodeDefinitionProps",
"nodeTypeProps": {
"type": "EntryUiNode",
"variant": {
"segment": "<string>",
"child": "<string>",
"reEnter": true,
"type": "EntryNode"
}
}
}
}
],
"edges": [
{
"source": "<string>",
"target": "<string>",
"data": {
"type": "JourneyUiDefinitionEdgeProps",
"disableMarker": true
}
}
]
}
}'
{
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"canRunMultiple": true,
"updatedAt": 123,
"draft": {
"nodes": [
{
"id": "<string>",
"data": {
"type": "JourneyUiNodeDefinitionProps",
"nodeTypeProps": {
"type": "EntryUiNode",
"variant": {
"segment": "<string>",
"child": "<string>",
"reEnter": true,
"type": "EntryNode"
}
}
}
}
],
"edges": [
{
"source": "<string>",
"target": "<string>",
"data": {
"type": "JourneyUiDefinitionEdgeProps",
"disableMarker": true
}
}
]
},
"status": "NotStarted",
"definition": {
"entryNode": {
"type": "EntryNode",
"segment": "<string>",
"child": "<string>",
"reEnter": true
},
"exitNode": {
"type": "ExitNode"
},
"nodes": [
{
"id": "<string>",
"type": "DelayNode",
"variant": {
"type": "Second",
"seconds": 123
},
"child": "<string>"
}
]
},
"createdAt": 123
}