Repairy Partner API
  1. Service Reminder
Repairy Partner API
  • Welcome 👋
  • Get Started
  • HTTP Headers
  • Authorization
  • Workshops
  • Bookings
  • Quotes
  • Service Reminder
  • Data Reporting
  • Booking URL
  • Error Codes
  • Technical Support
  • Changelog
  • Webhook
  • Additional Services
  • Service Catalog
  • APIs
    • Authorization
      • Access Token
      • Refresh Token
    • Workshops
      • Availabilities
      • Service Catalog
    • Bookings
      • Booking Request with Service Catalog (beta)
      • Booking Request
      • Booking Information
      • Update Booking Information
      • Update Booking Status
    • Quotes
      • Quote Request
    • Service Reminder
      • Service Reminder Notification
        POST
      • Service Reminder Information
        GET
    • Data Reporting
      • Partner Report
  • Data Structures
    • AuthResponse
    • Availability
    • CustomAvailability
    • Car
    • Customer
    • Booking
    • BookingUpdateRequest
    • BookingStatusUpdateConfig
    • Quote
    • ServiceHistory
    • ServiceReminder
    • WebhookRequest
    • ServiceCatalog
  1. Service Reminder

Service Reminder Notification

Cloud Mock
https://mock.apidog.com/m1/839892-0-default
Cloud Mock
https://mock.apidog.com/m1/839892-0-default
POST
/reminders/services

Send Immediate Service Reminder#

Send a Service Reminder Notification to a customer of a workshop, identified by Customer ID or Phone Number.

Request Requirements#

workshopId (required): Ensures the notification is sent for the correct workshop.
Customer Identification (one required):
customerId: Obtained after creating a Booking (takes precedence).
customerPhone: Must be in zero-leading format (e.g., 0400000001).

Notification Details#

The customer will receive an SMS containing:
A reminder link.
An 8-character reminder code (usable for rebooking).

New Customer Scenario#

If no customer is found with the given customerId or customerPhone:
1.
Repairy will create a new customer instance and link the car.
2.
The Service Reminder Notification will be sent based on the provided data.

Booking & Service History Lookup#

Using lastBookingId#

If present, Repairy will:
1.
Lookup the booking using lastBookingId.
2.
Record the booking into car service history.
3.
Send the reminder for the next booking.

Using lastServiceId (Higher Priority)#

If present, Repairy will:
1.
Lookup the service history using lastServiceId.
2.
Send the reminder for the next booking.
Note: lastServiceId takes priority over lastBookingId.

Request

Header Params

Body Params application/json

Example
{
    "workshopId": "WID",
    "externalId": "SOMEID123",
    "customerPhone": "0400000001",
    "carRego": "AAA001",
    "customerId": "CID",
    "customerEmail": "adi+cust@repairy.au",
    "customerFirstName": "Adi",
    "customerLastName": "Cust",
    "carYear": 2016,
    "carMake": "Mazda",
    "carModel": "MX-5",
    "carBadge": "Sport",
    "carVin": "ND5RC-136834",
    "lastServiceId": "SOMEID123",
    "lastBookingId": "SOMEID123",
    "internalNotes": "contains special notes from customer"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://mock.apidog.com/m1/839892-0-default/reminders/services' \
--header 'X-Partner-ID: PARTNER_ID' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workshopId": "WID",
    "externalId": "SOMEID123",
    "customerPhone": "0400000001",
    "carRego": "AAA001",
    "customerId": "CID",
    "customerEmail": "adi+cust@repairy.au",
    "customerFirstName": "Adi",
    "customerLastName": "Cust",
    "carYear": 2016,
    "carMake": "Mazda",
    "carModel": "MX-5",
    "carBadge": "Sport",
    "carVin": "ND5RC-136834",
    "lastServiceId": "SOMEID123",
    "lastBookingId": "SOMEID123",
    "internalNotes": "contains special notes from customer"
}'

Responses

🟢201Created
application/json
Created
Headers

Body

Example
{
    "success": true,
    "reminder": {
        "id": "",
        "code": "",
        "carId": "",
        "customerId": "",
        "workshopId": "",
        "lastServiceId": "",
        "lastBookingId": "",
        "newBookingId": "",
        "externalId": "",
        "car": {
            "id": "",
            "customerId": "",
            "rego": "",
            "year": 0,
            "make": "",
            "model": "",
            "badge": "",
            "vin": ""
        },
        "customer": {
            "id": "",
            "workshopId": "",
            "name": "",
            "firstName": "",
            "lastName": "",
            "email": "",
            "phone": "",
            "company": "",
            "address": "",
            "postcode": "",
            "suburb": ""
        },
        "category": "automated",
        "status": "pending",
        "date": "2025-07-03T03:30:00Z",
        "convertedDate": "2025-07-04T00:00:00Z",
        "smsSent": "2025-07-03T03:30:00Z",
        "smsSid": "",
        "customerPhone": "",
        "customerEmail": "",
        "emailSid": "",
        "emailSent": "2025-07-03T03:30:00Z",
        "createdAt": "2025-07-03T03:30:00Z",
        "updatedAt": "2025-07-04T00:00:00Z"
    }
}
🟠400Bad Request
Modified at 2025-04-03 04:21:18
Previous
Quote Request
Next
Service Reminder Information
Built with