Create Trip API
Explore how to create a trip with our Trip API
Create Trip
POST
https://api.roam.ai/v2/trips
Trips creation is also accessible via the API if you need to create trips on the fly.
Headers
Authorization*
String
Bearer <API-KEY>
Request Body
user_id
String
The user for which the trip is being tracked.
description
String
Description of the trip. By default the id is shown if the description is not set.
name
String
Name of the trip. By default the id is shown if the name is not set.
metadata
Dictionary
Set of key-value pairs that you can attach to the trip. This can be useful for storing additional information about the trip in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
stops
Array
For the trips with stop locations, add an array of stop locations.
stops.metadata
Dictionary
Set of key-value pairs that you can attach to the stop location. This can be useful for storing additional information about the stop location in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
stops.name
String
Name of the stop location. By default the id is shown if the name is not set.
stops.description
String
Description of the stop location. By default the id is shown if the description is not set.
stops.address
String
Address of the stop location.
stops.geometry_radius
Number
The radius in meters.
stops.geometry
Point
Location coordinates in GeoJSON format.
Example
Last updated