Update a reservation

Changes an existing reservation. Send only what you want to change, with one important exception (see the warning below). The reservation is repriced and saved, and the full priced view is returned.

Warning: additional drivers. If the request does not include additional_drivers (and does not include reservation_rates), every additional driver on the reservation is removed. To keep them, always send the full list of their contact IDs. The customer and the primary driver are not affected.

Partial-update rules.

Dates change only when both the date and the time are sent (pick_up_date with pick_up_time, return_date with return_time). The same applies to the flight date and time pairs.

additional_charges replaces the whole charge selection; mandatory charges are added back. If a requested charge is not available, the selection is left unchanged and the call still succeeds.

vehicle_class_id must belong to the reservation's branch, the class must be available, and the reservation must be open (or pending/pending-reserved when vehicles can be assigned to pending reservations). The assigned vehicle and rates are reset.

A pick-up location of another branch also needs a vehicle_class_id of that branch.

The customer fields (first_name, last_name, email, ...) edit the customer's contact record itself, which other reservations of that customer share. customer_id switches the reservation to another contact. Do not combine it with customer fields: these are written to the previous customer before the switch. Switch customer_id in one call and send the customer fields in a later call.

Discounts: add_discount=1 with coupon_code or manual_discount, remove_discount=1 with coupon_code, or remove_all_discounts=1.

Side effects. When the dates, flight dates, locations or vehicle class change, the users set to be notified of customer changes get an email and the car_rental_reservation_updated_by_customer webhook fires. A change of the total alone only sends that email. The customer is not emailed.

Retries. Send an Idempotency-Key header to make retries safe: a key already used on this path in the last 24 hours is rejected with 422. A business-rule failure (HTTP 200, success: false) also uses up the key. Cancelling a reservation through the API resets every stored key of your account.

An unknown reservation_id (numeric ID or UUID) returns 404.

Responses

🟢200OK

application/json

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). Business-rule failures here include dates that are not allowed or overbooked, a location or class change that is not allowed and a class that is not available. A 410 can come after earlier changes were already saved, so reload the reservation.

Bodyapplication/json

Examples

Reservation updatedClass change not allowed (HTTP 200)

{
    "success": true,
    "status_code": 200,
    "errors": [],
    "data": {
        "reservation": {
            "id": 1052,
            "header": "Jane Doe - RA #1052",
            "pick_up_date": "2026-12-02 09:00:00",
            "return_date": "2026-12-06 09:00:00",
            "flight_arrival_date": "2026-12-02 09:00:00",
            "flight_departure_date": "2026-12-06 09:00:00",
            "flight_number": "",
            "flight_departure_number": "",
            "pick_up_location": {
                "id": 1,
                "name": "Miami Airport",
                "timezone": "America/New_York"
            },
            "return_location": {
                "id": 1,
                "name": "Miami Airport",
                "timezone": "America/New_York"
            },
            "vehicle_class_id": 3,
            "customer_id": 4821,
            "public_link": "https://yourcompany.example.com/public/car-rental/reservations/step1?id=0d8e5b7a-2c4f-4a1e-9b3d-7f6a5c4e3b21&contact_uuid=5a4b3c2d-1e0f-4a9b-8c7d-6e5f4a3b2c1d",
            "comments": [],
            "distance_limits": {
                "distance_allowed": 0,
                "distance_limit_per_day": 0,
                "distance_unit": "mi",
                "distance_unlimited": true,
                "distance_extra_price": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "0.00",
                    "usd_amount": "0.00",
                    "amount_for_display": "$0.00"
                },
                "distance_extra_price_with_tax": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "0.00",
                    "usd_amount": "0.00",
                    "amount_for_display": "$0.00"
                }
            },
            "status": "open",
            "uuid": "0d8e5b7a-2c4f-4a1e-9b3d-7f6a5c4e3b21",
            "distance_driven": 0
        },
        "tour_operator": [],
        "selected_vehicle_class": {
            "vehicle_class_id": 3,
            "sipp_code": "CDAR",
            "price": {
                "total_days": 4,
                "base_price": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "180.00",
                    "usd_amount": "180.00",
                    "amount_for_display": "$180.00"
                },
                "base_price_with_taxes": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "198.00",
                    "usd_amount": "198.00",
                    "amount_for_display": "$198.00"
                },
                "details": [],
                "total_price_with_mandatory_charges_and_taxes": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "220.00",
                    "usd_amount": "220.00",
                    "amount_for_display": "$220.00"
                }
            },
            "vehicle_class": {
                "label": "Compact",
                "short_description": "Nissan Versa or similar",
                "description": "",
                "features": [],
                "image": "https://yourcompany.example.com/public/fleets/images/3f1c9e2a-7b4d-4c8e-9a6f-1d2e3c4b5a69/vehicle-class",
                "recommended": false
            }
        },
        "selected_additional_charges": [
            {
                "id": 12,
                "label": "GPS",
                "selection_type": "only_one",
                "selected_quantity": 1,
                "charge_type": "daily",
                "base_price": "5.00",
                "total_price": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "20.00",
                    "usd_amount": "20.00",
                    "amount_for_display": "$20.00"
                }
            }
        ],
        "external_charges": [],
        "vehicle_damages": [],
        "applicable_discounts": [],
        "applicable_taxes": [
            {
                "name": "Sales Tax (10%)",
                "base_price": 10,
                "charge_type": "percent",
                "total_amount": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "20.00",
                    "usd_amount": "20.00",
                    "amount_for_display": "$20.00"
                }
            }
        ],
        "total": {
            "show_security_deposit": true,
            "show_security_deposit_excess": false,
            "outstanding_balance": {
                "currency": "usd",
                "currency_icon": "$",
                "amount": "220.00",
                "usd_amount": "220.00",
                "amount_for_display": "$220.00"
            },
            "outstanding_security_deposit": {
                "currency": "usd",
                "currency_icon": "$",
                "amount": "300.00",
                "usd_amount": "300.00",
                "amount_for_display": "$300.00"
            },
            "security_deposit": {
                "currency": "usd",
                "currency_icon": "$",
                "amount": "300.00",
                "usd_amount": "300.00",
                "amount_for_display": "$300.00"
            },
            "security_deposit_excess": {
                "currency": "usd",
                "currency_icon": "$",
                "amount": "0.00",
                "usd_amount": "0.00",
                "amount_for_display": "$0.00"
            },
            "total_paid": {
                "currency": "usd",
                "currency_icon": "$",
                "amount": "0.00",
                "usd_amount": "0.00",
                "amount_for_display": "$0.00"
            },
            "total_price": {
                "currency": "usd",
                "currency_icon": "$",
                "amount": "220.00",
                "usd_amount": "220.00",
                "amount_for_display": "$220.00"
            }
        },
        "customer": {
            "id": 4821,
            "entity": "person",
            "first_name": "Jane",
            "last_name": "Doe",
            "email": "jane.doe@example.com",
            "phone_number": "+1 305 555 0142",
            "country": "US",
            "birthdate": "1990-04-15"
        },
        "additional_drivers": [
            {
                "id": 5120,
                "entity": "person",
                "first_name": "John",
                "last_name": "Doe",
                "email": "john.doe@example.com"
            }
        ]
    }
}

🟠422Record Not Found

🟠404Parameter Error

Request

Responses