Control Trip API
Explore how to control a trip with our Trip API
Control Trip
POST
https://api.roam.ai/v2/trips/:id/controls
Starts/Pauses/Resumes/Stops the trip for the given id.
Path Parameters
Name | Type | Description |
---|---|---|
id* | String | Updates the trip with the given ID. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer <API-KEY> |
Request Body
Name | Type | Description |
---|---|---|
user_id* | String | The user for which the trip is being tracked. |
started_at* | String | Timestamp is UTC for action:start eg: 2022-01-14T09:10:59.125 |
action* | String | To control the trip. eg. start, pause, resume, end |
paused_at* | String | Timestamp is UTC for action:pause eg: 2022-01-14T09:10:59.125 |
resumed_at* | String | Timestamp is UTC for action:resume eg: 2022-01-14T09:10:59.125 |
ended_at* | String | Timestamp is UTC for action:end eg: 2022-01-14T09:10:59.125 |
Example
Last updated