Force Terminate a Carpool Booking
POST/carpool/bookings/:booking_id/force-terminate
Ends a booking whose vehicle is in use and records the vehicle as returned now. This operation is available to the main account only. The request has no body and no notification is sent.
A booking in one of the ACTIVE statuses becomes FORCE_TERMINATED. Any
other status returns 409 with CARPOOL_BOOKING_STATE_CONFLICT, and
nothing is changed.
See Cancelling and Force Terminating for the responses and how to retry.
Request
Responses
- 200
- 401
- 403
- 404
- 409
- 422
- 429
- 500
- 503
The force terminated booking.
Unauthorized access. Authentication is required.
The operation requires main account credentials. Valid subusers receive this response.
The requested resource was not found.
The current status of the booking does not permit the action. Nothing was changed.
Validation failed for the input parameters.
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.