Update one or more booking sheet exceptions

PUT /api/booking-sheets/exception/{scheduleId}

Success: 200 OK

• Products: Operator (FOH)
• Features: Front of House Generic Access (FOHGENERIC)

Overview

Rewrites the exceptions produced by an existing recurring schedule. An exception blocks a resource product for a period of time so that no booking can be taken against it — a maintenance window, a staff meeting, a closure. A schedule is the recurrence definition that generates those exceptions, identified by the GUID returned in scheduleId when you created it with Create one or more booking sheet exceptions.

Send the schedule's definition in full. The request body is the same shape as the create call, and it replaces the stored definition outright: the schedule's future exception records are deleted and regenerated from the times and recurrence fields you send. Records that have already finished are left alone, so past exceptions survive an update. Anything you omit — days, notes, exclusion dates — is not carried over from the previous definition.

The endpoint expands your times into individual occurrences, one per date per entry in productIds, and checks them for clashes before writing anything. Nothing is written unless every check passes; there is no partial update.

Use this endpoint to:

• move or resize a closure that has already been scheduled
• change which resource products a schedule blocks out
• change the recurrence pattern, for example from every week to every other week
• add dates to skip, through exclusionDates

Read errors and exceptionsUpdated on every 200 OK. A clash sends back 400 (your own occurrences overlap each other) or 409 (they overlap existing bookings or other schedules' exceptions), in both cases with the full response body so you can see what collided. But if the recurrence produces no dates at all — for example days names a weekday that never falls inside the date range — the call succeeds with 200 OK, exceptionsUpdated: 0, an empty scheduleId and errors explaining why, and nothing has changed. Treating any 200 as success will leave you believing a closure is in place when it is not.

Endpoint

PUT {base_url}/api/booking-sheets/exception/{scheduleId}

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Path parameters

Request body

Sample request

curl -X PUT '{base_url}/api/booking-sheets/exception/{scheduleId}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true' \
  -H 'Content-Type: application/json' \
  -d '{
  "siteId": "string",
  "productIds": [
    "string"
  ],
  "days": [
    "string"
  ],
  "times": [
    {
      "timeBandId": "string",
      "dateTimeFrom": "2026-08-14T19:00:00Z",
      "dateTimeTo": "2026-08-14T19:00:00Z"
    }
  ],
  "notes": "string",
  "frequency": "string",
  "recursEvery": 1,
  "recurranceType": "string",
  "recursOn": 1,
  "exclusionDates": [
    "2026-08-14T19:00:00Z"
  ],
  "additionalDates": [
    "2026-08-14T19:00:00Z"
  ]
}'

Response fields

Sample response

{
  "exceptionsUpdated": 1,
  "scheduleId": "b7f3c1e2-9a44-4f2b-8c17-0d5e9a1b6c33",
  "errors": [
    "string"
  ],
  "overlappingExceptions": [
    {
      "dateTimeFrom": "2026-08-14T19:00:00Z",
      "dateTimeTo": "2026-08-14T19:00:00Z",
      "timeBandId": "string",
      "productId": "string"
    }
  ],
  "existingExceptions": [
    {
      "dateTimeFrom": "2026-08-14T19:00:00Z",
      "dateTimeTo": "2026-08-14T19:00:00Z",
      "timeBandId": "string",
      "productId": "string"
    }
  ],
  "existingBookings": [
    {
      "bookingId": 12345,
      "dateTimeFrom": "2026-08-14T19:00:00Z",
      "dateTimeTo": "2026-08-14T19:00:00Z",
      "timeBandId": "string",
      "productId": "string"
    }
  ]
}

Errors

This page as markdown · All pages · llms.txt