Create traveller journey
Adds a traveller to a specific journey. If the traveller does not exist as a company traveller, they will be automatically created and then subsequently added to the journey.
Create a new journey for traveller
Authorizations
Body
idstringRead-onlyRequired
short_idstring | nullableOptional
journeystringRequired
emailstring · emailRequired
namestringOptional
phonestringOptional
supervisorstring | nullableOptional
date_startstring · dateOptional
progressnumber · doubleRead-onlyRequired
statusstringRead-onlyRequired
picturestring · uriOptional
sourcestringWrite-onlyOptional
source_descriptionstringWrite-onlyOptional
Responses
201Success
application/json
400Error
application/json
401
Unauthorized
post
import requests
response = requests.post(
"https://journeys-api.50skills.app/v1/traveller-journeys",
json={
"email": "[email protected]",
"email": "Just Better",
"journey": "6mK7AyZV"
}
)
print(response.json())
{
"id": "9rKdez72",
"shortId": "9rKdez72",
"name": "Just Better",
"phone": null,
"journey": "6mK7AyZV",
"dateStart": "2023-01-01",
"progress": 1,
"status": "not_started",
"supervisor": {
"email": "[email protected]",
"isActive": true,
"name": "Phil Jackson",
"role": "admin",
"shortId": "7x89X78y"
},
"email": "[email protected]",
"picture": null,
"source": "Manually added",
"source_description": null,
"actions": [
{
"shortId": "AYGpl0Go",
"action": "journey_start",
"description": null,
"values": null,
"isAutomatic": false,
"isComplete": false,
"parentAction": null,
"savedValues": null,
"data": null,
"result": null
},
{
"short_id": "8oz3MlGp",
"action": "send_sms",
"description": "Send sms to traveller",
"values": {
"message": {
"value": "Sms message to traveller"
},
"recipients": [
{
"value": "+3546666666"
}
]
},
"isAutomatic": false,
"isComplete": false,
"parentAction": "AYGpl0Go",
"savedValues": null,
"data": {
"message": "Sms message to traveller",
"recipients": [
"+3546666666"
]
},
"result": null
}
]
}
Request samples
{
"journey":"8oz3gXzp",
"email":"[email protected]",
"name":"Pippin Took",
"phone":"+441234567890",
"journey_attribute__nLzNOaye":"2024-11-16",
"source":"Manually added"
}
Response samples
{
"id":"AOyeJ4GX"
}
Last updated