Update Booking Information

Modify Booking Details

Overview

Modifying your booking details is a straightforward process, designed to help you keep everything accurate and up to date. All you need to do is provide the Booking ID in your request. However, remember that only certain fields are editable, and it’s crucial to ensure that your request adheres to the API’s validation rules. By doing so, you’ll avoid any unnecessary errors and ensure the smooth update of your booking.

Requirements

Before you begin updating your booking, here’s what you’ll need to ensure:

Booking ID: Every booking has a unique identifier. You must include this ID to locate the booking you want to modify.

Editable Fields: Not all fields are available for modification. Only the editable fields can be changed, so double-check which fields are accessible for updates.

API Validation: To maintain data integrity, your request must pass the API's validation checks. Ensure that your request follows the correct format and includes all necessary information to prevent validation errors.

How to Update Booking Status

If your goal is to change the status of a booking, you can easily do so by using the Update Booking Status endpoint. This allows you to modify the status according to your needs. It’s a quick and efficient way to ensure that the booking status aligns with the current situation.

👉 Update Booking Status

Pro Tip: To ensure the process goes smoothly, always double-check that you're updating the correct fields. If you're unsure, refer to the available fields for modification or consult with your team for guidance.

Update Booking Confirmation

Once the update request has been successfully submitted, the system will begin processing the changes to the booking details. Upon successful processing, a confirmation response will be returned. This response will:

Confirm that the booking has been successfully updated.

Include a unique bookingId that can be used to track or reference the updated booking.

Customer Notification on Date Change

If the booking date is changed as part of the update:

The customer will automatically receive a notification via SMS and email informing them of the updated schedule.

Skipping Notifications (Optional)

In certain situations, you may want to suppress notifications to the customer.
To do this, include the optional field:

"skipNotification": true

When set to true, no SMS or email will be sent to the customer regarding the booking update.

Note: This only affects customer notifications. Workshop notifications are not triggered for booking updates.

Request

Path Params

Header Params

Body Params application/json

Example

{
    "date": "2025-11-03T03:30:00Z",
    "serviceCategory": "tyres",
    "services": [
        {
          "catalogCode": "brake-inspection",
          "title": "Comprehensive Brake System Inspection - Pads, Rotors, Fluid & Performance Check",
          "category": "repair",
          "cost": 89.00,
          "maxCost": 120.00
        }
    ],
    "carRego": "ABB123",
    "customerName": "John Doe",
    "customerPhone": "0400000001",
    "customerEmail": "john@repairy.com.au",
    "customerCompany": "",
    "notes": "",
    "interval": 0,
    "pickupTime": "2025-11-03T05:30:00Z",
    "servicePackageType": "tyres",
    "jobNotes": [
        "Tyre Purchasing",
        "Nitrogen Inflation"
    ],
    "productNotes": [],
    "tyreQuantities": 0
}

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"
    }
}

🟠404Record Not Found

Modify Booking Details#

Overview#

Requirements#

How to Update Booking Status#

Update Booking Confirmation#

Customer Notification on Date Change#

Skipping Notifications (Optional)#