Skip to main content
POST
Start a new journey

Authorizations

Authorization
string
header
required

Customer JWT token for journey lifecycle operations. Required for: journey/start, journey/state/fetch, device/start

Body

application/json
resourceId
string
required
Minimum string length: 1
Pattern: ^[a-zA-Z0-9_-]+(@[a-zA-Z0-9_.-]+)?$
context
object
required
scenario
object

Response

Journey started

instanceId
string
required
status
enum<string>
required
Available options:
started
instanceUrl
string
message
string