Apply a free vehicle class upgrade

Gives the customer a vehicle of a better class at the price of the class they booked. The reservation keeps its booked class and price, and records the upgrade class. The assigned vehicle is detached (and a vehicle of the new class is assigned automatically when your account assigns vehicles with availability per location).

Requires the role permission Can Give Free Vehicle Class Upgrades to Customers?; without it the response is a real HTTP 403.

Rules

The reservation must be open, or pending / pending-reserved when your settings allow assigning vehicles to pending reservations.

The class must be of the same branch, different from the booked class, and available for the dates.

Response. data is a detailed reservation payload. Rely only on the keys listed below and call GET /car-rental/reservations/{reservation_id} for the full overview.

Responses

🟢200OK

application/json

The upgrade was applied, or a business error. HTTP 200 is also used for failures: always check success. When it is false, the body is an ErrorBusinessRule (status_code 410) or an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Examples

Class not availableReservation cannot be updated

{
    "success": false,
    "status_code": 410,
    "errors": {
        "availability": [
            "The selected vehicle class is not available"
        ],
        "error_message": "The selected vehicle class is not available"
    },
    "data": []
}

🟠403Forbidden

🟠404Record Not Found

Apply a free vehicle class upgrade

Request

Responses