R24 External Partner APIs
Partner Travel EndpointsSupportAbout R24
Partner Travel EndpointsSupportAbout R24
  1. Partner Travel Endpoints
  • Approved Travel (get)
    GET
  • Approved Travel (post)
    POST
  1. Partner Travel Endpoints

Approved Travel (post)

POST
/approved_travel
Approved Travel

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Body Params application/json
org_id
string <uuid>
required
Organization / Tenant ID
source_system_id
string <uuid>
required
The distinct identifier of the partner system tasked with supplying this data
approved_travel
array [object {14}] 
required
user_email
string <email>
required
Email address of the user
travel_status
enum<integer> <int32>
Travel Status
required
The current state of the travel.
Allowed values:
0123
departure_address
string 
required
Departure Address
Example:
2 Nizels Knoll, Nizels Lane, Hildenborough, Kent, UK, TN11 8NU
departure_country_code
string 
required
Depature Country (code 3)
Example:
GBR
departure_latitude
number <double>
required
Departure Latitude
Example:
51.231380271453126
departure_longitude
number <double>
required
Departure Longitude
Example:
0.2124915109713824
departure_datetime
string <date-time>
date-time
required
Expected Departure Date and Time (format: YYYY-MM-DDThh:mm:ssZ)
Example:
YYYY-MM-DDThh:mm:ssZ
destination_address
string 
required
Destination Address
Example:
45 Kingfisher Dr, Fourways, Sandton, Johannesburg, 2055
destination_country_code
string 
required
Destination Country (code 3)
Example:
ZAF
destination_latitude
number <double>
required
Destination Latitude
Example:
-26.026765138629315
destination_longitude
number <double>
required
Destination Longitude
Example:
28.007101310304233
arrival_datetime
string <date-time>
date-time
required
Expected Arrival Date and Time (format: YYYY-MM-DDThh:mm:ssZ)
Example:
YYYY-MM-DDThh:mm:ssZ
checkin_datetime
string <date-time> | null 
optional
Check-In Date and Time (format: YYYY-MM-DDThh:mm:ssZ)
source_system_ref
string 
required
The distinctive reference number for this record within the partner system
>= 8 characters
Example
{
  "org_id": "9675ba27-cba8-76ea-70d3-5f735382d8d8",
  "source_system_id": "270e8ec8-7536-1b99-9cfe-2231ae00f625",
  "approved_travel": [
    {
      "user_email": "Jedidiah.Dickinson@yahoo.com",
      "travel_status": 0,
      "departure_address": "2 Nizels Knoll, Nizels Lane, Hildenborough, Kent, UK, TN11 8NU",
      "departure_country_code": "GBR",
      "departure_latitude": 51.231380271453126,
      "departure_longitude": 0.2124915109713824,
      "departure_datetime": "2025-05-19 13:25:52.700605",
      "destination_address": "45 Kingfisher Dr, Fourways, Sandton, Johannesburg, 2055",
      "destination_country_code": "ZAF",
      "destination_latitude": -26.026765138629315,
      "destination_longitude": 28.007101310304233,
      "arrival_datetime": "2025-05-20 11:25:52.700605",
      "source_system_ref": "d8fd07cf-8a0f-5341-59a9-e323c6beb30b"
    },
    {
      "user_email": "Noemie.Turner@hotmail.com",
      "travel_status": 1,
      "departure_address": "2 Nizels Knoll, Nizels Lane, Hildenborough, Kent, UK, TN11 8NU",
      "departure_country_code": "GBR",
      "departure_latitude": 51.231380271453126,
      "departure_longitude": 0.2124915109713824,
      "departure_datetime": "2025-04-19 13:25:52.700605",
      "destination_address": "45 Kingfisher Dr, Fourways, Sandton, Johannesburg, 2055",
      "destination_country_code": "ZAF",
      "destination_latitude": -26.026765138629315,
      "destination_longitude": 28.007101310304233,
      "arrival_datetime": "2025-04-20 11:25:52.700605",
      "source_system_ref": "54e1b8d0-38c0-bf97-0ab9-cc5d8447476d"
    }
  ]
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://dev.your-api-server.com/approved_travel' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "org_id": "9675ba27-cba8-76ea-70d3-5f735382d8d8",
    "source_system_id": "270e8ec8-7536-1b99-9cfe-2231ae00f625",
    "approved_travel": [
        {
            "user_email": "Jedidiah.Dickinson@yahoo.com",
            "travel_status": 0,
            "departure_address": "2 Nizels Knoll, Nizels Lane, Hildenborough, Kent, UK, TN11 8NU",
            "departure_country_code": "GBR",
            "departure_latitude": 51.231380271453126,
            "departure_longitude": 0.2124915109713824,
            "departure_datetime": "2025-05-19 13:25:52.700605",
            "destination_address": "45 Kingfisher Dr, Fourways, Sandton, Johannesburg, 2055",
            "destination_country_code": "ZAF",
            "destination_latitude": -26.026765138629315,
            "destination_longitude": 28.007101310304233,
            "arrival_datetime": "2025-05-20 11:25:52.700605",
            "source_system_ref": "d8fd07cf-8a0f-5341-59a9-e323c6beb30b"
        },
        {
            "user_email": "Noemie.Turner@hotmail.com",
            "travel_status": 1,
            "departure_address": "2 Nizels Knoll, Nizels Lane, Hildenborough, Kent, UK, TN11 8NU",
            "departure_country_code": "GBR",
            "departure_latitude": 51.231380271453126,
            "departure_longitude": 0.2124915109713824,
            "departure_datetime": "2025-04-19 13:25:52.700605",
            "destination_address": "45 Kingfisher Dr, Fourways, Sandton, Johannesburg, 2055",
            "destination_country_code": "ZAF",
            "destination_latitude": -26.026765138629315,
            "destination_longitude": 28.007101310304233,
            "arrival_datetime": "2025-04-20 11:25:52.700605",
            "source_system_ref": "54e1b8d0-38c0-bf97-0ab9-cc5d8447476d"
        }
    ]
}'

Responses

🟢200Success
application/json
Body
response_status
enum<integer> 
required
The status of the request for the creation or modification of approved travel
Allowed values:
10
response_comment
string 
required
Further remarks concerning the request to establish or modify authorized travel
response_detail
array[object (Travel Request Detail) {3}] 
required
source_system_ref
string 
required
The distinctive reference number for this record within the partner system
>= 8 characters
response_status
enum<integer> 
Record Status
required
The status of the request for the creation or modification of approved travel
Allowed values:
10
response_comment
string 
required
Further remarks concerning the request to establish or modify authorized travel
Example
{
  "response_status": 0,
  "response_comment": "Not all of the records were processed",
  "response_detail": [
    {
      "source_system_ref": "d8fd07cf-8a0f-5341-59a9-e323c6beb30b",
      "response_status": 1,
      "response_comment": ""
    },
    {
      "source_system_ref": "54e1b8d0-38c0-bf97-0ab9-cc5d8447476d",
      "response_status": 0,
      "response_comment": "No organizational user was located based on the provided email address"
    }
  ]
}
🟠400Bad Request
🟠401Unauthorized
Previous
Approved Travel (get)