Update Booking Status

To update the status of a booking, simply provide the Booking ID in your request. This will allow you to modify the status and ensure the necessary actions are carried out.

Requirements

Before updating a booking status, make sure the following requirements are met:

You must have a valid Booking ID. This unique identifier is necessary to target the specific booking you wish to modify.

The status update must follow the allowed status transitions. Each status has predefined transitions, meaning not all status changes are permitted. Ensure the transition you intend to make is valid.

Once the status is updated, certain post-actions will automatically be triggered based on the new status. These actions are designed to streamline the booking lifecycle and ensure a smooth customer experience.

Post-Action Behavior

When the booking status is updated to Completed (done), the system will automatically trigger the following actions to enhance the customer experience:

1. Review Invitation

A review invitation will be sent to the customer, giving them an opportunity to share feedback on the service received.

This feedback helps improve future service quality and customer satisfaction.

2. Optional: Skip Notification

To prevent this review invitation from being sent, include the following in your request:

"skipNotification": "customer"

This will suppress the review invitation and no notification will be delivered to the customer.

3. Next Service Reminder

If applicable, a reminder for the next scheduled service will be configured.

This ensures the customer is notified ahead of time and helps keep future bookings organized and timely.

These actions are automated to save time and ensure a seamless flow from one booking status to the next, enhancing the overall process for both customers and service providers.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Headers

Body

Example

{
    "success": true,
    "booking": {
        "id": "",
        "code": "",
        "carId": "",
        "customerId": "",
        "workshopId": "",
        "externalId": "",
        "car": {
            "id": "",
            "customerId": "",
            "rego": "",
            "year": 0,
            "make": "",
            "model": "",
            "badge": "",
            "vin": ""
        },
        "customer": {
            "id": "",
            "workshopId": "",
            "name": "",
            "firstName": "",
            "lastName": "",
            "email": "",
            "phone": "",
            "company": "",
            "address": "",
            "postcode": "",
            "suburb": ""
        },
        "status": "pending",
        "date": "2025-11-03T03:30:00Z",
        "servicePackageType": "tyres",
        "customerCompany": "",
        "notes": "",
        "interval": 0,
        "jobNotes": [
            "Tyre Purchasing",
            "Nitrogen Inflation"
        ],
        "productNotes": [],
        "tyreQuantities": 0,
        "createdAt": "2025-11-03T03:30:00Z",
        "updatedAt": "2025-11-03T03:30:00Z"
    },
    "service": {
        "id": "",
        "carId": "",
        "customerId": "",
        "workshopId": "",
        "bookingId": "",
        "reminderId": "",
        "car": {
            "id": "",
            "customerId": "",
            "rego": "",
            "year": 0,
            "make": "",
            "model": "",
            "badge": "",
            "vin": ""
        },
        "customer": {
            "id": "",
            "workshopId": "",
            "name": "",
            "firstName": "",
            "lastName": "",
            "email": "",
            "phone": "",
            "company": "",
            "address": "",
            "postcode": "",
            "suburb": ""
        },
        "notes": "",
        "interval": 0,
        "skipReminder": false,
        "servicePeriod": 6,
        "servicePackageType": "tyres",
        "serviceDate": "2025-01-03T03:30:00Z",
        "reminderAt": "2025-07-03T03:30:00Z",
        "reminderSentAt": "2025-07-03T03:30:00Z",
        "createdAt": "2025-01-03T03:30:00Z",
        "updatedAt": "2025-07-03T03:30:00Z"
    }
}

🟠400Bad Request

Update Booking Status