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/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
API Reference
PUT /api/admin/journeys/
Create or update a journey.
PUT
/
api
/
admin
/
journeys
/
Authorization
string
*
Authorization
Required
string
object
*
id
string
id
string
workspaceId
string
*
workspaceId
Required
string
name
string
*
name
Required
string
canRunMultiple
boolean
canRunMultiple
boolean
updatedAt
number
updatedAt
number
definition
object
definition
object
entryNode
Segment Entry Node · object
*
entryNode
Required
object
The first node in a journey - triggered when a user enters a segment.
type
enum<string>
*
type
Required
enum<string>
segment
string
*
segment
Required
string
child
string
*
child
Required
string
reEnter
boolean
reEnter
boolean
exitNode
object
*
exitNode
Required
object
Defines when a user exits a journey. Allows users to re-enter the journey, under some set of conditions.
type
enum<string>
*
type
Required
enum<string>
nodes
array
*
nodes
Required
array
status
Option 1 · enum<string>
status
enum<string>
draft
object
draft
object
nodes
array
*
nodes
Required
array
edges
array
*
edges
Required
array
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 Available options:
DelayNode Available options:
NotStarted Response
200 - application/json
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 Available options:
DelayNode