Skip to main content
POST
/
journey
/
device
/
start
Create connect token
curl --request POST \
  --url https://eu.platform.go.gbgplc.com/captain/api/journey/device/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instanceId": "PiIuACmx8Q8R7qPnAkLAqBAT",
  "scope": [
    "mobile"
  ]
}
'
{
  "connectToken": "FtKXWJ7dQ6HTEDa9ScPWzNKY0kHoG_wA",
  "tokenType": "connect",
  "expiresIn": "120",
  "scope": [
    "mobile"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
instanceId
string
required

A unique identifier for a started journey instance.

Example:

"PiIuACmx8Q8R7qPnAkLAqBAT"

​
scope
enum<string>[]
required

Device types allowed to connect. Use mobile for mobile devices, desktop for desktop browsers, or * / any for all device types.

Available options:
mobile,
desktop,
*,
any
Example:
["mobile"]

Response

Connect token created successfully.

​
connectToken
string
required

A short-lived token used by the end-user device to connect to the journey.

​
tokenType
enum<string>
required

The type of token returned.

Available options:
connect
​
expiresIn
string
required

Number of seconds until the connect token expires.

​
scope
string[]
required

Device types that can use this token.