Create inspection

Summary

The Create Inspection API endpoint allows for the creation of a new inspection record. Upon successfully creating the inspection, the endpoint returns a unique identifier (UUID) for the newly created inspection. This UUID can be used in conjunction with the Get Inspection endpoint to retrieve the full details of the inspection.

Notes

The InspectionDate field is optional. If provided, the inspection will be scheduled for the specified date with a status of Booked. If omitted, the inspection will be created with a status of Pending and the customer will be prompted to choose an inspection date that suits them when managing their appointment.

The InspectionDate field should include a timezone offset. If no offset is provided, the date will be assumed to be in UTC. However, please be aware that not including an offset may result in unintended booking times, especially during daylight saving periods . To ensure accuracy, it is recommended to always specify the timezone offset when providing an InspectionDate.

For example,

"InspectionDate": "2024-09-11T14:30:00+01:00"

In this example, +01:00 is the offset indicating that the time is 1 hour ahead of UTC.

Endpoint Specification

post
Authorizations
Query parameters
api-versionstringOptional
Body
ClientIdstring · uuidOptional
InspectionTypeIdstring · uuidOptional
InspectionDatestring · date-time | nullableOptional
CustomReferencestring | nullableOptional
InspectorEmailstring | nullableOptional
IncludeAreaIdsstring · uuid[] | nullableOptional
Responses
200

Returns the Id of the the created inspection

Responsestring · uuid
post
/api/v1/Inspections
POST /api/v1/Inspections HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 482

{
  "Occupier": {
    "Forename": "text",
    "Surname": "text",
    "Mobile": "text",
    "Email": "text"
  },
  "Property": {
    "Line1": "text",
    "Line2": "text",
    "Line3": "text",
    "Town": "text",
    "County": "text",
    "Postcode": "text",
    "Latitude": "text",
    "Longitude": "text"
  },
  "ClientId": "123e4567-e89b-12d3-a456-426614174000",
  "InspectionTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "InspectionDate": "2025-11-07T15:39:26.992Z",
  "CustomReference": "text",
  "InspectorEmail": "text",
  "IncludeAreaIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
123e4567-e89b-12d3-a456-426614174000

Last updated