Update an inspection (status, notes, photos, PDF URL)

PATCH

/api/v1/inspections/{id}

curl --request PATCH \
  --url https://api.dokanmazad.com/api/v1/inspections/clx1insp0001a2b3c4d5e6f \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "status": "Completed", "notes": "Engine sound normal, AC functional", "pdfReportUrl": "https://cdn.dokanmazad.com/inspections/report-002.pdf" }'

• Production
• Local dev

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

id

required

string

Inspection CUID

Example

clx1insp0001a2b3c4d5e6f

Request Body^required

Media typeapplication/json

object

status

Status transition — Pending | InProgress | Completed | Cancelled (not all transitions are valid; Completed is terminal)

string

inspectorId

Reassign to a different inspector (CUID)

string

inspectionDate

Updated inspection date (ISO 8601 string or Date)

string format: date-time

notes

Updated inspection notes

string

photos

Updated photo array — each photo: { url, thumbnailUrl?, type?, caption?, priority?, uploadedAt? }

Array

pdfReportUrl

URL to the generated PDF report

string

Examples

Exampledefault

{
  "status": "Completed",
  "notes": "Engine sound normal, AC functional",
  "pdfReportUrl": "https://cdn.dokanmazad.com/inspections/report-002.pdf"
}

Responses

200

Success

Media typeapplication/json

object

success

required

boolean

data

required

meta

object

page

integer

limit

integer

total

integer

totalPages

integer

data

required

object

id

required

Inspection CUID

string

orderId

required

Parent order CUID

string

status

required

Updated inspection status (Pending | InProgress | Completed | Cancelled)

string

notes

Inspection notes

string

pdfReportUrl

PDF report URL

string

inspectionDate

Inspection date

string format: date-time

updatedAt

required

Last updated timestamp

string format: date-time

Examples

Examplesuccess

{
  "success": true,
  "data": {
    "id": "clx1insp0001a2b3c4d5e6f",
    "orderId": "cmosor2zy000313ny24hgtfy0",
    "status": "Completed",
    "notes": "Engine sound normal, AC functional",
    "pdfReportUrl": "https://cdn.dokanmazad.com/inspections/report-002.pdf",
    "inspectionDate": "2026-05-22T14:00:00.000Z",
    "updatedAt": "2026-05-22T15:00:00.000Z"
  }
}

401

Unauthorized — missing or invalid API key

Media typeapplication/json

object

success

required

boolean

error

required

string

statusCode

required

integer

Example

{
  "success": false
}

403

Forbidden — route not in this key’s allowedRoutes

Media typeapplication/json

object

success

required

boolean

error

required

string

statusCode

required

integer

Example

{
  "success": false
}

429

Rate limit exceeded

Media typeapplication/json

object

success

required

boolean

error

required

string

statusCode

required

integer

Example

{
  "success": false
}

Headers

Retry-After

integer

Seconds to wait before retrying