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 traveller journey

post

Create a new journey for traveller

Authorizations

Body

multipart/form-dataapplication/json

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

{
  "id": "9rKdez72",
  "shortId": "9rKdez72",
  "name": "Just Better",
  "phone": null,
  "journey": "6mK7AyZV",
  "dateStart": "2023-01-01",
  "progress": 1,
  "status": "not_started",
  "supervisor": {
    "email": "[e-mail]",
    "isActive": true,
    "name": "Phil Jackson",
    "role": "admin",
    "shortId": "7x89X78y"
  },
  "email": "[e-mail]",
  "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": "[phone]"
          }
        ]
      },
      "isAutomatic": false,
      "isComplete": false,
      "parentAction": "AYGpl0Go",
      "savedValues": null,
      "data": {
        "message": "Sms message to traveller",
        "recipients": [
          "[phone]"
        ]
      },
      "result": null
    }
  ]
}

Request samples

Application/JSON

{
   "journey":"8oz3gXzp",
   "email":"[e-mail]",
   "name":"Pippin Took",
   "phone":"[phone]",
   "journey_attribute__nLzNOaye":"2024-11-16",
   "source":"Manually added"
}

Python

import requests
response = requests.post(
    "https://journeys-api.50skills.app/v1/traveller-journeys/",
    json={
        "journey": "8oz3gXzp",
        "email": "[e-mail]",
        "name": "Pippin Took",
        "phone": "[phone]",
        "journey_attribute__nLzNOaye": "2024-11-16",
        "source": "Manually added"
        ],
    }
)
print(response.json())               

Response samples

201 (Created)

{
   "id":"AOyeJ4GX"
}