Enrol a Vehicle in Carpool
POST/carpool/vehicles
Enrols a vehicle that already exists in the fleet into the Carpool
inventory. The vehicle must be visible to the caller, and no vehicle row is
created. A vehicle that is already enrolled returns 409.
The optional configuration fields set the vehicle up in the same call.
A field left out keeps any value the vehicle already has, for example from
an earlier enrolment that was removed. setup_status in the response
reports whether the account's Carpool settings still require something.
This operation is available to the main account only.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 422
- 429
- 500
- 503
The enrolled vehicle.
The request body is declared as JSON but cannot be parsed, or is not a JSON object or array. Nothing was processed.
Unauthorized access. Authentication is required.
The operation requires main account credentials. Valid subusers receive this response.
The requested resource was not found.
The vehicle or driver is already enrolled in Carpool. Nothing was written.
Request field validation or Carpool business validation failed.
Too Many Requests - the endpoint's rate limit has been exceeded. Retry after the number of seconds in the Retry-After header.
Response Headers
Seconds to wait before retrying. The same value as X-RateLimit-Retry-After-Seconds when that wait is non-negative. If the computed wait is negative, Retry-After is floored at 0.
Unix timestamp of the next earliest successful request.
Seconds until the next earliest successful request.
Internal server error.
Service temporarily unavailable. The request did not complete and can be retried after the number of seconds in the Retry-After header, when one is sent.
Response Headers
Seconds to wait before retrying. Sent with db_busy and db_pool_timeout.