Log a trip check call
Logs a check call (driver status update) on an in-progress trip. Only accepted while the trip is Covered, Dispatched, or In Transit.
Covered, Dispatched, or In Transit); a check call on a terminal, pre-dispatch, or post-delivery-billing trip is rejected with 422.
Endpoint
Request Parameters
Request Body
Example CURL request
{version} with 1.0, {tripId} with the actual trip ID, and YOUR_ACCESS_TOKEN with a valid token.
Response Body
The created check-call object:Example Response (201 Created)
Status Codes
Rate Limits
All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information, see the Rate Limits section.Try It Out
This page is interactive, allowing you to try a request by specifying the API version and tripId in the URL path and editing the request body. As you fill out the parameters, the cURL command on the right side of the page will be automatically updated. Alternatively, you can directly edit the cURL command. ⚠️ Don’t forget: make sure to authorize yourself before trying a request.Authorizations
OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as Authorization: Bearer <token>.
Path Parameters
API version (e.g., 1.0)
"1.0"
Body
Free-text note for the check call (e.g. the driver's reply).
1 - 4000The activity reported (e.g. Driving, At Pickup).
100Id of the driver to attribute the check call to. Must be one of the trip's assigned drivers.
100Response
Created
Unique identifier of the check call.
Load number the check call belongs to.
Free-text note captured with the check call.
Id of the trip the check call belongs to.
When the check call was recorded (UTC).
The activity reported.
Categorization of the response (e.g. arrival, departure).
Name of the user or integration that logged the check call.
Assigned driver's name, if known.
Related trip number, if known.