Create Exception

Summary

The Create Exception API endpoint allows you to record a period during which a user is unavailable to host inspections.

Notes

The Start and End fields should include a timezone offset. If no offset is provided, the date will be assumed to be in UTC. To ensure accuracy, it is recommended to always specify the timezone offset when providing a value.

For example,

"Start": "2024-09-11T14:30:00+01:00",
"End": "2024-09-11T15:30:00+01:00"

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

If the specified exception period conflicts with one or more existing bookings, the API will return a 409 conflict response. The response body will include a list of the conflicting appointments, allowing the caller to review or resolve the scheduling conflict before retrying the request.

Endpoint Specification

post
Authorizations
Query parameters
api-versionstringOptional
Body
Emailstring | nullableOptional
Startstring · date-timeOptional
Endstring · date-timeOptional
Responses
204

Work pattern exception created

No content
post
/api/v1/WorkPatterns/Exceptions
POST /api/v1/WorkPatterns/Exceptions HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "Email": "text",
  "Start": "2025-11-07T15:59:11.677Z",
  "End": "2025-11-07T15:59:11.677Z"
}
No content
PreviousWork Patterns

Last updated