Journeys
  • Introduction
  • Getting access
  • Authentication
  • Terminology
  • API reference
    • Authorization
      • Authorize
    • Company
      • Retrieve company
      • Update company
    • Company lists
      • Retrieve company list
      • List company lists
      • Create company list
      • Update company list
      • Delete company list
    • Journeys
      • List journeys
      • Retrieve journey
      • Delete journey
      • Edit journey
    • Journey actions
      • List journey actions
      • Retrieve journey action
      • Delete journey action
    • Traveller journeys
      • List traveller journeys
      • Retrieve traveller journey
      • Retrieve actions
      • Start traveller journey
      • Create traveller journey
      • Delete traveller journey
    • Traveller journey actions
      • List journey traveller actions
      • Retrieve journey traveller action
    • Users
      • Invite
      • List users
      • Create user
      • Retrieve user
      • Delete user
      • Update user
  • Specification
Powered by GitBook
On this page
  1. API reference
  2. Traveller journeys

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.

PreviousStart traveller journeyNextDelete traveller journey

Last updated 1 year ago

Request samples

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

Response samples

{
   "id":"AOyeJ4GX"
}

Create traveller journey

post

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
{
  "id": "9rKdez72",
  "shortId": "9rKdez72",
  "name": "Just Better",
  "phone": null,
  "journey": "6mK7AyZV",
  "dateStart": "2023-01-01",
  "progress": 1,
  "status": "not_started",
  "supervisor": {
    "email": "jackson@bulls.nba",
    "isActive": true,
    "name": "Phil Jackson",
    "role": "admin",
    "shortId": "7x89X78y"
  },
  "email": "michael@jordan.com",
  "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
    }
  ]
}