Skip to main content
POST
/
journey
/
start
Start journey
curl --request POST \
  --url https://eu.platform.go.gbgplc.com/v2/captain/journey/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resourceId": "97c8b0c5272ba450c48899cc78f6e3f3ba89b5d131c42f7ea972588bd8213b3e@y5z6bj7o",
  "context": {
    "config": {
      "delivery": "page"
    },
    "subject": {}
  }
}
'
{
  "instanceId": "Pq_hhIX6-sHUy9FLSDzPLu",
  "instanceUrl": "/journey/Pq_hhIX6-sHUy9FLSDzPLu",
  "status": "started",
  "message": "Journey Pq_hhIX6-sHUy9FLSDzPLu started successfully"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
resourceId
string
required

Unique identifier for the journey. Append '@latest' to use the most recent version.

Example:

"97c8b0c5272ba450c48899cc78f6e3f3ba89b5d131c42f7ea972588bd8213b3e@y5z6bj7o"

​
context
object

Prefilled identity data for the journey.

Example:
{
  "config": { "delivery": "page" },
  "subject": {}
}

Response

Journey started successfully.

​
instanceId
string

Unique identifier for the active journey instance.

​
instanceUrl
string

The URL path for the hosted journey page.

​
status
string

Indicates the result of the start request.

​
message
string

Human-readable confirmation message.