CheckSchedulingConflictsRequest

A request or response body; the type column links to the schemas it refers to.

CheckSchedulingConflictsRequest

FieldTypeRequiredDescription
user_idsarray of string (uuid)yes

`users.id` of the people about to be scheduled.

1–250 items

windowsarray of TrainingEventWindowyes

The windows they would be scheduled in — one for a single event, one per event for a series. Conflicts name the window by its index in this array.

1–200 items

exclude_event_idstring (uuid)no

An event to leave out of the check: the one being edited, whose own roster would otherwise conflict with itself.

jsonExample
{
  "user_ids": [
    "1b671a64-40d5-491e-99b0-da01ff1f3341"
  ],
  "windows": [
    {
      "starts_at": "2026-01-01T00:00:00.000Z",
      "ends_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "exclude_event_id": "1b671a64-40d5-491e-99b0-da01ff1f3341"
}