RoadBays REST API
Base URL: https://www.roadbays.com/api

Getting Started

All API requests must be sent over HTTPS. Authentication is handled via a Bearer token in the Authorization header of every request.

Welcome to the RoadBays API. To get started, sign into your account, navigate to Company Settings → API, and generate your API key.

Include your key as a Bearer token on every request:

bash
curl --location --request GET 'https://www.roadbays.com/api/v1_Cases' \
--header 'Authorization: Bearer YOUR_API_KEY_HERE'
Cases
GET

List Cases

GET https://www.roadbays.com/api/v1_Cases?startdate={date}&enddate={date}

Retrieve a list of cases filtered by date range using the case open date.

bash
curl --location --request GET \
  'https://www.roadbays.com/api/v1_Cases?startdate=10-1-2021&enddate=10-4-2021' \
  --header 'Authorization: Bearer YOUR_API_KEY'
json — response
[
  {
    "id": 408500,
    "dateCreated": "2021-10-03T09:07:13.84",
    "inactive": 0,
    "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192",
    "dateOpened": "2021-10-03T09:07:13.84",
    "dateCompleted": "2021-10-03T09:09:56.12",
    "dateClosed": "2021-10-03T09:09:56.12",
    "assignedUser": 81,
    "vendors": {
      "id": 10464,
      "name": "Shop Location 1",
      "address": "1234 Main Ave",
      "city": "Green Bay",
      "zip": "54304",
      "email": "test@email.com",
      "phone": "92012345687",
      "latitude": 47.254547,
      "longitude": -67.9403301,
      "vendorType": "CustomerShop",
      "ranking": 6
    },
    "vendorsId": 10464,
    "caseNumber": 8,
    "caseStatus": { "id": 3, "name": "Closed" },
    "caseStatusId": 3,
    "description": "Test Header",
    "units": {
      "id": 1030,
      "unitNumber": "3345",
      "description": "Mack Truck",
      "unitTypesId": 1014,
      "serialNo": "1XPBDP956AD486131",
      "engine": "MP8",
      "engineManufacturer": "MACK",
      "unitMake": "MACK",
      "unitModel": "Anthem",
      "modelYear": "2020",
      "unitSearchLabel": "3345 Tractor"
    },
    "unitsId": 1030,
    "repairReasonsId": 12,
    "priority": { "id": 5, "value": "5" },
    "priorityId": 5,
    "maintenanceBoard": 1
  }
]
Query Parameters
ParameterTypeDescription
AuthorizationstringBearer token API key required
startdateDateTimeStart date filter by case open date required
enddateDateTimeEnd date filter by case open date required
GET

Get Case

GET https://www.roadbays.com/api/v1_Cases/{caseId}

Retrieve full details for a single case by its RoadBays system-generated ID.

bash
curl --location --request GET \
  'https://www.roadbays.com/api/v1_Cases/408500' \
  --header 'Authorization: Bearer YOUR_API_KEY'
json — response
{
  "id": 408500,
  "dateCreated": "2021-10-03T09:07:13.84",
  "inactive": 0,
  "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192",
  "dateOpened": "2021-10-03T09:07:13.84",
  "dateCompleted": "2021-10-03T09:09:56.12",
  "dateClosed": "2021-10-03T09:09:56.12",
  "assignedUser": 81,
  "vendors": null,
  "vendorsId": 10464,
  "caseNumber": 8,
  "driverId": null,
  "caseStatus": null,
  "caseStatusId": 3,
  "description": "This is a case description",
  "locationDescription": null,
  "units": null,
  "unitsId": 100030,
  "repairReasonsId": 12,
  "offSet": "-05:00",
  "latitude": null,
  "longitude": null,
  "priority": null,
  "priorityId": 5,
  "maintenanceBoard": 1
}
Path Parameters
ParameterTypeDescription
AuthorizationstringBearer token API key required
caseIdintegerRoadBays system-generated case ID required
POST

Create Case by VIN

POST https://www.roadbays.com/api/v1_Cases

Create a new maintenance case linked to an asset by VIN. The asset must already exist in your RoadBays account.

bash
curl --location --request POST \
  'https://www.roadbays.com/api/v1_Cases' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'vin=1XPCEP6Y0JD486131' \
  --data-urlencode 'description=Case Description' \
  --data-urlencode 'assignedUser=81' \
  --data-urlencode 'locDescription=located in NE corner of lot' \
  --data-urlencode 'latitude=44.503807048107156' \
  --data-urlencode 'longitude=-88.0080488474994' \
  --data-urlencode 'userField1=custom field data 1' \
  --data-urlencode 'userField2=custom field data 2'
json — response
{
  "id": 4102,
  "dateCreated": "2021-10-24T20:40:44.428835-05:00",
  "inactive": 0,
  "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192",
  "dateOpened": "2021-10-24T20:40:44.428835-05:00",
  "dateCompleted": null,
  "dateClosed": null,
  "assignedUser": 81,
  "vendors": null,
  "vendorsId": null,
  "caseNumber": 39,
  "driverId": null,
  "caseStatus": null,
  "caseStatusId": 1,
  "description": "Case Description",
  "units": null,
  "unitsId": 1030,
  "repairReasonsId": null,
  "offSet": "-05:00",
  "latitude": null,
  "longitude": null,
  "priority": null,
  "priorityId": 5,
  "maintenanceBoard": 1
}
POST

Create Case Note

POST https://www.roadbays.com/api/v1_CaseNotes

Append a text note to an existing case. Notes appear in the case communication feed visible to all assigned parties.

bash
curl --location --request POST \
  'https://www.roadbays.com/api/v1_CaseNotes' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'caseId=4102' \
  --data-urlencode 'noteText=Hello World'
Body Parameters
json — response
{
  "id": 2176,
  "dateCreated": "2021-10-24T20:42:57.4429432-05:00",
  "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192",
  "createdBy": "Roadbays API_External",
  "createdByName": "Roadbays API_External",
  "note": "Hello World",
  "caseID": 4102,
  "offSet": "-05:00"
}
ParameterTypeDescription
AuthorizationstringBearer token API key required
caseIdintegerRoadBays system-generated case ID required
noteTextstringText to append to the case note feed required
POST

Case Notification

POST https://www.roadbays.com/api/v1CaseNotifications

Send a notification for a case via Email or SMS. Set NotificationTypesId to 2 for Email or 3 for SMS.

bash
curl --location --request POST \
  'https://www.roadbays.com/api/v1CaseNotifications' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'CaseId=4102' \
  --data-urlencode 'NotificationTypesId=3' \
  --data-urlencode 'NotificationContact=9207640865' \
  --data-urlencode 'CaseHeader=True' \
  --data-urlencode 'CaseNotes=True'
Body Parameters
json — response
{
  "id": 39,
  "caseId": 4102,
  "invoiceId": 0,
  "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192",
  "inactive": 0,
  "dateCreated": "2021-12-05T05:59:37",
  "notificationTypesId": 3,
  "notificationContact": "9207640865",
  "caseHeader": true,
  "caseNotes": true
}
ParameterTypeDescription
AuthorizationstringBearer token API key required
CaseIdintegerRoadBays system-generated case ID required
NotificationTypesIdintegerEmail = 2 · SMS = 3 required
NotificationContactstringEmail address or phone number required
CaseHeaderboolNotify on case header changes required
CaseNotesboolNotify on new case notes required
GET

Share Case

GET https://www.roadbays.com/api/v1_CaseShare?caseId={id}

Generate a public shareable URL for a case. Returns a signed link that can be shared with external parties who don't have a RoadBays account.

bash
curl --location --request GET \
  'https://www.roadbays.com/api/v1_CaseShare?caseId=4102' \
  --header 'Authorization: Bearer YOUR_API_KEY'
Query Parameters
json — response
{ "url": "https://www.roadbays.com/caseShared/details?key=KsOKGoz5uZLPi2&caseId=4102&invoiceId=0" }
ParameterTypeDescription
AuthorizationstringBearer token API key required
caseIdintegerRoadBays system-generated case ID required
Invoices
GET

List Invoices

GET https://www.roadbays.com/api/v1_Invoices?startdate={date}&enddate={date}

Retrieve a list of invoices filtered by date range using the invoice open date.

bash
curl --location --request GET \
  'https://www.roadbays.com/api/v1_Invoices?startdate=10-1-2021&enddate=10-4-2021' \
  --header 'Authorization: Bearer YOUR_API_KEY'
Query Parameters
json — response
[
  {
    "id": 4074,
    "dateCreated": "2022-02-08T12:39:42.78",
    "inactive": 0,
    "accountGUID": "aae3e95d-dbd7-42fe-8786-440e867f4176",
    "unitsId": 2379,
    "units": {
      "id": 2379,
      "unitNumber": "98765",
      "description": "2018 Peterbilt MX13",
      "serialNo": "1XPBDP9X0JD486131",
      "unitMake": "Peterbilt",
      "unitModel": "MX13",
      "modelYear": "2018"
    },
    "vendorId": 1033,
    "dateOpened": "2022-02-08T06:39:02",
    "caseNumber": 6,
    "invoiceNumber": 5,
    "invoiceStatus": { "id": 1, "name": "Open" },
    "invoiceStatusId": 1,
    "description": "test",
    "offSet": "-06:00"
  }
]
ParameterTypeDescription
AuthorizationstringBearer token API key required
startdateDateTimeStart date filter by invoice open date required
enddateDateTimeEnd date filter by invoice open date required
GET

Get Invoice

GET https://www.roadbays.com/api/v1_Invoices/{invoiceId}

Retrieve full details for a single invoice by its RoadBays system-generated ID.

bash
curl --location --request GET \
  'https://www.roadbays.com/api/v1_Invoices/408500' \
  --header 'Authorization: Bearer YOUR_API_KEY'
Path Parameters
json — response
{
  "id": 4149,
  "dateCreated": "2022-09-27T13:46:03.3531728+00:00",
  "inactive": 0,
  "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192",
  "stripeInvoiceId": null,
  "unitsId": 3779,
  "units": null,
  "driverId": 0,
  "vendorId": 0,
  "dateOpened": "2022-09-27T13:46:03.3531728+00:00",
  "dateCompleted": null,
  "dateClosed": null,
  "caseNumber": 20,
  "invoiceNumber": 0,
  "invoiceStatus": null,
  "invoiceStatusId": 1,
  "description": "testinvoice",
  "locationDescription": "locationDescription",
  "odometer": 0,
  "offSet": "-05:00"
}
ParameterTypeDescription
AuthorizationstringBearer token API key required
invoiceIdintegerRoadBays system-generated invoice ID required
POST

Create Invoice by VIN

POST https://www.roadbays.com/api/v1_Invoices

Create a new invoice linked to an asset by VIN and an existing case number.

bash
curl --location --request POST \
  'https://www.roadbays.com/api/v1_Invoices' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'vin=1XPCEP6Y0JD486131' \
  --data-urlencode 'description=Invoice Description' \
  --data-urlencode 'caseNumber=44' \
  --data-urlencode 'locDescription=located in NE corner of lot'
Body Parameters
json — response
{
  "id": 4149,
  "dateCreated": "2022-09-27T13:46:03.3531728+00:00",
  "inactive": 0,
  "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192",
  "unitsId": 3779,
  "driverId": 0,
  "vendorId": 0,
  "dateOpened": "2022-09-27T13:46:03.3531728+00:00",
  "caseNumber": 20,
  "invoiceStatusId": 1,
  "description": "testinvoice",
  "locationDescription": "locationDescription",
  "offSet": "-05:00"
}
ParameterTypeDescription
AuthorizationstringBearer token API key required
vinstringVIN of an existing unit in RoadBays required
caseNumberintegerRoadBays system-generated case number required
descriptionstringInvoice description required
locDescriptionstringLocation description optional
GET

Get Invoice Payments

GET https://www.roadbays.com/api/v1_InvoicePayments/{invoiceId}

Retrieve payment records associated with a specific invoice.

bash
curl --location --request GET \
  'https://www.roadbays.com/api/v1_InvoicePayments/3157' \
  --header 'Authorization: Bearer YOUR_API_KEY'
Path Parameters
json — response
{
  "AccountGUID": "a5a4032b-2150-4c51-b1b3-f7c2c0ae4f70",
  "AccountID": 0,
  "Amount": 120.00,
  "CreatedByName": "Demo User",
  "DateCreated": "2023-01-31T17:45:39.357",
  "Id": 3157,
  "Inactive": 0,
  "InvoiceId": 4193,
  "PaymentTypesId": 2011
}
ParameterTypeDescription
AuthorizationstringBearer token API key required
invoiceIdintegerRoadBays system-generated invoice ID required
Resources
GET

List Repair Reasons

GET https://www.roadbays.com/api/v1_RepairReasons

Returns all repair reasons configured for your account. Use the returned id values when creating cases.

bash
curl --location --request GET \
  'https://www.roadbays.com/api/v1_RepairReasons' \
  --header 'Authorization: Bearer YOUR_API_KEY'
Parameters
json — response
[
  { "id": 11, "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192", "inactive": 0, "dateCreated": "2021-08-20T11:01:30.07", "name": "Breakdown", "notes": null },
  { "id": 12, "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192", "inactive": 0, "dateCreated": "2021-08-20T11:01:33.757", "name": "Driver Abuse", "notes": null },
  { "id": 13, "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192", "inactive": 0, "dateCreated": "2021-08-20T11:01:37.433", "name": "Accident", "notes": null }
]
ParameterTypeDescription
AuthorizationstringBearer token API key required
GET

List Users

GET https://www.roadbays.com/api/v1_CustomerUsers

Returns all users registered to your account. Use the returned id as the assignedUser value when creating cases.

bash
curl --location --request GET \
  'https://www.roadbays.com/api/v1_CustomerUsers' \
  --header 'Authorization: Bearer YOUR_API_KEY'
Parameters
json — response
[
  {
    "id": 81,
    "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192",
    "inactive": 0,
    "dateCreated": "2021-08-20T11:00:10",
    "userTypesId": 2,
    "email": "demo@roadbays.com",
    "firstName": "Demo",
    "lastName": "User"
  }
]
ParameterTypeDescription
AuthorizationstringBearer token API key required
Drivers
GET

List Drivers

GET https://www.roadbays.com/api/v1_Drivers

Returns all drivers registered to your account.

bash
curl --location --request GET \
  'https://www.roadbays.com/api/v1_Drivers' \
  --header 'Authorization: Bearer YOUR_API_KEY'
Parameters
json — response
[
  {
    "id": 1011,
    "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192",
    "inactive": 0,
    "dateCreated": "2022-02-21T05:32:48.15",
    "firstName": "Demo",
    "lastName": "User",
    "email": "demo@roadbays.com",
    "employeeId": "111111",
    "balance": "1000",
    "phone": "9203141144"
  }
]
ParameterTypeDescription
AuthorizationstringBearer token API key required
POST

Create Driver

POST https://www.roadbays.com/api/v1_Drivers

Register a new driver to your RoadBays account. First name, last name, and email are required.

bash
curl --location --request POST \
  'https://www.roadbays.com/api/v1_Drivers' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'firstName=Demo' \
  --data-urlencode 'lastName=User' \
  --data-urlencode 'email=demo@roadbays.com' \
  --data-urlencode 'phone=9203141144' \
  --data-urlencode 'employeeId=1111111' \
  --data-urlencode 'balance=1000'
Body Parameters
json — response
{
  "id": 1011,
  "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192",
  "inactive": 0,
  "dateCreated": "2022-02-21T05:32:48.15",
  "firstName": "Demo",
  "lastName": "User",
  "email": "demo@roadbays.com",
  "employeeId": "111111",
  "balance": "1000",
  "phone": "9203141144"
}
ParameterTypeDescription
AuthorizationstringBearer token API key required
firstNamestringDriver first name required
lastNamestringDriver last name required
emailstringDriver email address required
phonestringPhone number optional
employeeIdstringInternal employee identifier optional
balancestringAccount balance optional
Units
GET

List Units

GET https://www.roadbays.com/api/v1_Units

Returns all fleet assets (units) registered to your account.

bash
curl --location --request GET \
  'https://www.roadbays.com/api/v1_Units' \
  --header 'Authorization: Bearer YOUR_API_KEY'
Parameters
json — response
[
  {
    "id": 1030,
    "dateCreated": "2021-08-20T11:04:50.503",
    "inactive": 0,
    "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192",
    "unitNumber": "3345",
    "description": "Mack Truck",
    "unitTypesId": 1014,
    "serialNo": "1XAPDP9X0PD486131",
    "engine": "MP8",
    "engineManufacturer": "MACK",
    "unitMake": "MACK",
    "unitModel": "Anthem",
    "modelYear": "2020"
  }
]
ParameterTypeDescription
AuthorizationstringBearer token API key required
GET

Get Unit

GET https://www.roadbays.com/api/v1_Units/{unitId}

Retrieve full details for a single unit by its RoadBays system-generated ID.

bash
curl --location --request GET \
  'https://www.roadbays.com/api/v1_Units/1030' \
  --header 'Authorization: Bearer YOUR_API_KEY'
Path Parameters
json — response
{
  "id": 1030,
  "dateCreated": "2021-08-20T11:04:50.503",
  "inactive": 0,
  "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192",
  "unitNumber": "3345",
  "description": "Mack Truck",
  "unitTypesId": 1014,
  "serialNo": "1XAPDP9X0PD486131",
  "engine": "MP8",
  "engineManufacturer": "MACK",
  "unitMake": "MACK",
  "unitModel": "Anthem",
  "modelYear": "2020"
}
ParameterTypeDescription
AuthorizationstringBearer token API key required
unitIdintegerRoadBays system-generated unit ID required
POST

Create Unit

POST https://www.roadbays.com/api/v1_Units

Add a new fleet asset to your account. Vehicle specs are automatically decoded from the VIN via NHTSA.

bash
curl --location --request POST \
  'https://www.roadbays.com/api/v1_Units' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'vin=1XPCEP6Y0JD486131' \
  --data-urlencode 'unitNumber=12345' \
  --data-urlencode 'unitTypeId=1001' \
  --data-urlencode 'license=1XY23Z45'
Body Parameters
json — response
{
  "id": 1030,
  "dateCreated": "2021-08-20T11:04:50.503",
  "inactive": 0,
  "accountGUID": "b5b1032a-6336-4d51-c1z3-bad295795192",
  "unitNumber": "12345",
  "unitTypesId": 1001,
  "serialNo": "1XPCEP6Y0JD486131",
  "license": "1XY23Z45",
  "unitMake": "PETERBILT",
  "unitModel": "389",
  "modelYear": "2019"
}
ParameterTypeDescription
AuthorizationstringBearer token API key required
vinstring17-character vehicle VIN required
unitTypeIdintegerRoadBays unit type ID required
unitNumberstringYour internal unit/fleet number required
licensestringLicense plate number optional
POST

Create Fault Code

POST https://www.roadbays.com/api/v1_FaultCodes

Push DTC fault codes into RoadBays from your telematics provider. Codes are matched to the asset by VIN and linked to open cases automatically.

bash
curl --location --request POST \
  'https://www.roadbays.com/api/v1_FaultCodes' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'vin=1XPCEP6Y0JD486131' \
  --data-urlencode 'code=P1401' \
  --data-urlencode 'codeDescription=Crankcase Air Pressure' \
  --data-urlencode 'status=open' \
  --data-urlencode 'source=Crankcase' \
  --data-urlencode 'platform=api' \
  --data-urlencode 'externalId=367423'
Body Parameters
json — response
{
  "id": 68139,
  "externalId": "367423",
  "dateCreated": "2022-03-21T15:15:09",
  "inactive": 0,
  "accountGUID": "b6b1032b-3150-4c51-2548-f7b3b7a8e9f70",
  "units": null,
  "unitsId": 3379,
  "caseId": 5141,
  "serialNo": "1XPCEP6Y0JD486131",
  "code": "P1401",
  "codeDescription": "Crankcase Air Pressure",
  "source": "Crankcase",
  "platform": "api",
  "status": "open",
  "firstObserved": "3/21/2022 3:15:09 PM",
  "lastObserved": "3/21/2022 3:15:09 PM"
}
ParameterTypeDescription
AuthorizationstringBearer token API key required
vinstringVIN of the unit in RoadBays required
codestringDTC fault code (e.g. P1401) required
codeDescriptionstringHuman-readable description of the code optional
platformstringLabel of originating platform (e.g. Samsara) optional
statusstringopen or closed optional
sourcestringSource bus or system of the code optional
externalIdstringYour external ID — use to update status later optional
PUT

Update Fault Code

PUT https://www.roadbays.com/api/v1_FaultCodes

Update the status of an existing fault code. Identify the record using either the RoadBays internal id or the externalId assigned at creation. One of the two is required.

bash
curl --location --request PUT \
  'https://www.roadbays.com/api/v1_FaultCodes' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'id=145585' \
  --data-urlencode 'externalId=1455a58s45' \
  --data-urlencode 'status=closed'
Body Parameters
json — response
{
  "id": 68139,
  "externalId": "1455a58s45",
  "dateCreated": "2022-03-21T15:15:09",
  "inactive": 0,
  "accountGUID": "b6b1032b-3150-4c51-2548-f7b3b7a8e9f70",
  "unitsId": 3379,
  "caseId": 5141,
  "serialNo": "23TYG1EG0GFA91368",
  "code": "P054A",
  "codeDescription": "Cold Start B Camshaft Position Timing Over-Advanced Bank 1",
  "source": "CANBUS_SECONDARY_PASSENGER_15765",
  "platform": null,
  "status": "closed",
  "firstObserved": "3/20/2022 4:13:01 PM",
  "lastObserved": "3/20/2022 4:13:01 PM"
}
ParameterTypeDescription
AuthorizationstringBearer token API key required
idintegerRoadBays internal fault code ID — required if no externalId
externalIdstringYour external ID — required if no id
statusstringOpen or Closed required
POST

Update Mileage

POST https://www.roadbays.com/api/v1_Mileage

Push updated mileage for a unit by VIN. The mileage value must be greater than the current recorded value to update correctly.

bash
curl --location --request POST \
  'https://www.roadbays.com/api/v1_Mileage' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'vin=1XPCEP6Y0JD486131' \
  --data-urlencode 'mileage=145585'
Body Parameters
json — response
{
  "id": 68139,
  "dateCreated": "2022-03-21T15:15:09",
  "inactive": 0,
  "accountGUID": "b6b1032b-3150-4c51-2548-f7b3b7a8e9f70",
  "unitsId": 3379,
  "caseId": 0,
  "serialNo": "1XPCEP6Y0JD486131",
  "mileage": "145585"
}
ParameterTypeDescription
AuthorizationstringBearer token API key required
vinstringVIN of the unit to update required
mileagestringMust be greater than current recorded mileage required
Reference

Error Codes

The RoadBays API uses standard HTTP status codes. Errors return a JSON body with a message field describing the issue.

CodeMeaning
401 Unauthorized — Verify your Bearer token is correct and included in the Authorization header.
403 Forbidden — Your API key does not have permission to access this endpoint.
404 Not Found — The requested resource ID does not exist. Verify the ID and try again.
500 Internal Server Error — An unexpected server error occurred. Please try again later.
503 Service Unavailable — The API is temporarily offline for maintenance. Please try again later.