Cancel a Carpool Booking
POST/carpool/bookings/:booking_id/cancel
Cancels one booking with a reason from GET /carpool/cancel-reasons. This operation is available to the main account only.
A booking that is REQUESTED, APPROVED, EXPIRING_APPROVAL or in one of
the ACTIVE statuses becomes CANCELLED, and the driver is sent the
account's configured cancellation SMS and email. 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
- 500
The cancelled 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.
Internal server error.