Change a rotation's configuration
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Patch, RequestUri = new Uri("https://api.roundrobinbot.eu/v1/rotations/example"), Headers = { { "If-Match", "example" }, { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"channels\": [ \"example\" ], \"code\": \"example\", \"description\": \"example\", \"enableTopic\": true, \"enabled\": true, \"lanes\": 1, \"name\": \"example\", \"owners\": [ \"example\" ], \"public\": true, \"topicTemplate\": \"example\" }") { Headers = { ContentType = new MediaTypeHeaderValue("application/*+json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}package main
import ( "fmt" "strings" "net/http" "io")
func main() {
url := "https://api.roundrobinbot.eu/v1/rotations/example"
payload := strings.NewReader("{ \"channels\": [ \"example\" ], \"code\": \"example\", \"description\": \"example\", \"enableTopic\": true, \"enabled\": true, \"lanes\": 1, \"name\": \"example\", \"owners\": [ \"example\" ], \"public\": true, \"topicTemplate\": \"example\" }")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("If-Match", "example") req.Header.Add("Authorization", "Bearer <token>") req.Header.Add("Content-Type", "application/*+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/*+json");RequestBody body = RequestBody.create(mediaType, "{ \"channels\": [ \"example\" ], \"code\": \"example\", \"description\": \"example\", \"enableTopic\": true, \"enabled\": true, \"lanes\": 1, \"name\": \"example\", \"owners\": [ \"example\" ], \"public\": true, \"topicTemplate\": \"example\" }");Request request = new Request.Builder() .url("https://api.roundrobinbot.eu/v1/rotations/example") .patch(body) .addHeader("If-Match", "example") .addHeader("Authorization", "Bearer <token>") .addHeader("Content-Type", "application/*+json") .build();
Response response = client.newCall(request).execute();import axios from 'axios';
const options = { method: 'PATCH', url: 'https://api.roundrobinbot.eu/v1/rotations/example', headers: { 'If-Match': 'example', Authorization: 'Bearer <token>', 'Content-Type': 'application/*+json' }, data: '{ "channels": [ "example" ], "code": "example", "description": "example", "enableTopic": true, "enabled": true, "lanes": 1, "name": "example", "owners": [ "example" ], "public": true, "topicTemplate": "example" }'};
try { const { data } = await axios.request(options); console.log(data);} catch (error) { console.error(error);}const url = 'https://api.roundrobinbot.eu/v1/rotations/example';const options = { method: 'PATCH', headers: { 'If-Match': 'example', Authorization: 'Bearer <token>', 'Content-Type': 'application/*+json' }, body: '{ "channels": [ "example" ], "code": "example", "description": "example", "enableTopic": true, "enabled": true, "lanes": 1, "name": "example", "owners": [ "example" ], "public": true, "topicTemplate": "example" }'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.roundrobinbot.eu/v1/rotations/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/*+json' \ --header 'If-Match: example' \ --data '{ "channels": [ "example" ], "code": "example", "description": "example", "enableTopic": true, "enabled": true, "lanes": 1, "name": "example", "owners": [ "example" ], "public": true, "topicTemplate": "example" }'Changes only the fields you send. Anything you leave out keeps its current value, so renaming a rotation means sending the name and nothing else. description and code take an empty string to clear them. owners and channels replace the current list rather than adding to it. Answers with the rotation and a fresh ETag. The cadence and the on-call state are changed elsewhere. How often a rotation hands over belongs to a coverage window, so it is set with PUT /v1/rotations/{rotationId}/coverage, and who is on call with the on-call endpoints. Widening lanes past one is a paid feature, and a free workspace asking for it answers 402 with nothing changed. A workspace that has downgraded keeps the lanes it paid for, and a body that repeats the number it already runs is not a widening. Switching a rotation back on answers 402 as well when the people in it would put the workspace over what its plan allows, because only enabled rotations count towards that number. Nothing changes, and the rotation stays switched off.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Header Parameters
Section titled “Header Parameters”The ETag from your last read of this resource, sent back exactly as you received it, quotes included. The write happens only if nothing changed in between: a stale validator is answered 412 and nothing is written. Send * to write against whatever is current on purpose. Omitting the header is 428, never an unconditional write. https://docs.roundrobinbot.eu/api/conventions/#conditional-writes
Request Bodyrequired
Section titled “Request Bodyrequired”The parts of a rotation’s configuration PATCH /v1/rotations/{rotationId} will change.
object
The Slack channel ids the rotation posts to, replacing the current list wholesale. The app must already be in every channel named.
The short code the rotation answers to in Slack. Send "" to clear it; omit to leave it. Must be unique in the workspace, and a clash is refused rather than resolved.
A sentence about what the rotation covers. Send "" to clear it; omit to leave it.
Whether the rotation keeps channel topics pointed at whoever is on duty. With it off, no channel’s topic is written whatever its own syncsTopic says.
Whether the rotation is running. A disabled rotation keeps its members and its schedule, and nobody is on call in it: it plans nothing and hands over nothing. Enabling it again restarts it, and an automatic rotation puts on call the person after the one who was on call when it was disabled.
How many lanes the rotation runs: one person holds each lane.
What the rotation is called.
The Slack user ids that may administer the rotation, replacing the current list wholesale. Send [] to leave the rotation with no owners beyond workspace admins.
Whether every member of the workspace can see the rotation.
The template the topic is written from. Send an empty string to fall back to Round Robin’s own wording.
Examplegenerated
{ "channels": [ "example" ], "code": "example", "description": "example", "enableTopic": true, "enabled": true, "lanes": 1, "name": "example", "owners": [ "example" ], "public": true, "topicTemplate": "example"}The parts of a rotation’s configuration PATCH /v1/rotations/{rotationId} will change.
object
The Slack channel ids the rotation posts to, replacing the current list wholesale. The app must already be in every channel named.
The short code the rotation answers to in Slack. Send "" to clear it; omit to leave it. Must be unique in the workspace, and a clash is refused rather than resolved.
A sentence about what the rotation covers. Send "" to clear it; omit to leave it.
Whether the rotation keeps channel topics pointed at whoever is on duty. With it off, no channel’s topic is written whatever its own syncsTopic says.
Whether the rotation is running. A disabled rotation keeps its members and its schedule, and nobody is on call in it: it plans nothing and hands over nothing. Enabling it again restarts it, and an automatic rotation puts on call the person after the one who was on call when it was disabled.
How many lanes the rotation runs: one person holds each lane.
What the rotation is called.
The Slack user ids that may administer the rotation, replacing the current list wholesale. Send [] to leave the rotation with no owners beyond workspace admins.
Whether every member of the workspace can see the rotation.
The template the topic is written from. Send an empty string to fall back to Round Robin’s own wording.
Examplegenerated
{ "channels": [ "example" ], "code": "example", "description": "example", "enableTopic": true, "enabled": true, "lanes": 1, "name": "example", "owners": [ "example" ], "public": true, "topicTemplate": "example"}The parts of a rotation’s configuration PATCH /v1/rotations/{rotationId} will change.
object
The Slack channel ids the rotation posts to, replacing the current list wholesale. The app must already be in every channel named.
The short code the rotation answers to in Slack. Send "" to clear it; omit to leave it. Must be unique in the workspace, and a clash is refused rather than resolved.
A sentence about what the rotation covers. Send "" to clear it; omit to leave it.
Whether the rotation keeps channel topics pointed at whoever is on duty. With it off, no channel’s topic is written whatever its own syncsTopic says.
Whether the rotation is running. A disabled rotation keeps its members and its schedule, and nobody is on call in it: it plans nothing and hands over nothing. Enabling it again restarts it, and an automatic rotation puts on call the person after the one who was on call when it was disabled.
How many lanes the rotation runs: one person holds each lane.
What the rotation is called.
The Slack user ids that may administer the rotation, replacing the current list wholesale. Send [] to leave the rotation with no owners beyond workspace admins.
Whether every member of the workspace can see the rotation.
The template the topic is written from. Send an empty string to fall back to Round Robin’s own wording.
Examplegenerated
{ "channels": [ "example" ], "code": "example", "description": "example", "enableTopic": true, "enabled": true, "lanes": 1, "name": "example", "owners": [ "example" ], "public": true, "topicTemplate": "example"}The parts of a rotation’s configuration PATCH /v1/rotations/{rotationId} will change.
object
The Slack channel ids the rotation posts to, replacing the current list wholesale. The app must already be in every channel named.
The short code the rotation answers to in Slack. Send "" to clear it; omit to leave it. Must be unique in the workspace, and a clash is refused rather than resolved.
A sentence about what the rotation covers. Send "" to clear it; omit to leave it.
Whether the rotation keeps channel topics pointed at whoever is on duty. With it off, no channel’s topic is written whatever its own syncsTopic says.
Whether the rotation is running. A disabled rotation keeps its members and its schedule, and nobody is on call in it: it plans nothing and hands over nothing. Enabling it again restarts it, and an automatic rotation puts on call the person after the one who was on call when it was disabled.
How many lanes the rotation runs: one person holds each lane.
What the rotation is called.
The Slack user ids that may administer the rotation, replacing the current list wholesale. Send [] to leave the rotation with no owners beyond workspace admins.
Whether every member of the workspace can see the rotation.
The template the topic is written from. Send an empty string to fall back to Round Robin’s own wording.
Examplegenerated
{ "channels": [ "example" ], "code": "example", "description": "example", "enableTopic": true, "enabled": true, "lanes": 1, "name": "example", "owners": [ "example" ], "public": true, "topicTemplate": "example"}Responses
Section titled “Responses”OK
A rotation: the grid of duties it runs, who is in it, and who holds each place right now.
object
Every lane crossed with every window, and whoever holds each one.
A lane crossed with a window: one place somebody can be on duty.
object
Whoever holds this place, or nothing.
object
End of this holder’s current stretch of cover: the window closing, or the turn ending if that comes first. Null while nothing bounds the stretch, and while the holder is not covering (the window is shut or the holder is waiting): nextCoverage.startUtc gives when cover resumes.
Members the list would otherwise have named, who were passed over because they were absent. A skip, decided once before the shift starts, rather than a hand-over of part of one.
A member skipped because of an absence at assignment time.
object
Absence start in UTC, when known.
Absence source: googleCalendar or internalAvailability. Null when the source is unknown.
Absence end in UTC, when known.
Slack user ID of the skipped member.
Their position in the list this place is dealt from, and absent for a person a partner named, who was never dealt from a list at all.
When this holder’s turn ends: the next hand-over of the place, which can be later than coveredUntil when the window closes first. Null where nothing hands the place over.
The Slack user holding the place, or null when a partner named somebody Slack cannot.
Whether they are waiting for the window to open rather than on duty right now.
Which list this place is dealt from, matching an entry in the rotation’s rosters.
Whether this place is defined but not running, because the workspace is not on a paid plan.
Every channel this rotation uses, each saying what Round Robin does in it. Write one with PUT /v1/rotations/{rotationId}/channels/{channelId}.
One Slack channel a rotation uses, and what Round Robin does in it.
object
The Slack channel id, for example C0123456789.
Whether hand-overs, reminders and mentions of this rotation are posted in this channel.
Whether this channel’s topic is rewritten with whoever is on duty when duty changes hands. Reported as false on every channel when enableTopic is off, whatever the channel itself holds, so a reader never has to combine two fields to know whether a topic is written.
The channels this rotation posts in: the same facts as channelSettings, flattened to the ids that receive duty messages.
The short code the rotation answers to in Slack.
Whether one person may hold two places at once when the list behind them is too short to fill both.
Whether the rotation keeps channel topics pointed at whoever is on duty. The switch for the whole rotation: with it off, no channel’s topic is written whatever its own syncsTopic says.
How many places on this rotation have somebody on call right now.
Whether this rotation has more than one place to be on duty at once.
The rows of the grid: the kinds of duty this rotation runs.
A row of the grid: a kind of duty, such as primary or backend.
object
What the customer calls this lane, and absent until they name it.
Everybody in the rotation: the union across every list it draws on.
object
Members that came in through a Slack user group, listed under the group they came from. Add or remove somebody in Slack’s group and the rotation follows.
A Slack user group in the rotation, and the people currently in it.
object
One member of a rotation.
object
Where the member sits in the order the lists are built from.
Members added individually.
One member of a rotation.
object
Where the member sits in the order the lists are built from.
manual, auto or external.
The on-call resource, embedded, so the common question needs no second call.
object
Current external assignment summary, including unmapped participants, empty slots and the next known boundary.
object
UTC instant used to evaluate current assignments and coverage.
Number of current user assignments, including unmapped participants and duplicate assignments.
Coverage: assigned when a user assignment is active; empty when only explicit empty assignments are active; gap for a confirmed interval with no assignments; otherwise unknown.
Synchronized assignments active at asOfUtc, including unmapped participants, duplicate assignments and explicit empty slots.
One external assignment interval, including an explicitly unassigned slot.
object
Cell holding the synchronized assignment, or null for a future assignment without a stored cell.
Provider metadata for this assignment.
object
Assignment member kind: user or empty.
Provider end of the occurrence in UTC.
Original provider start of the occurrence in UTC.
Provider override ID for an override source.
Provider participant ID for a user assignment. Null for an empty slot.
Provider rotation ID for a rotation or rotation-override source.
Provider custom-shift ID for a custom-shift or custom-shift-override source.
Provider source type: schedule_rotation, custom_shift, schedule_rotation_override or custom_shift_override.
Provider email address when available. Null for explicit empty slots or when no email is available.
Display label for an unmapped participant: provider name, email address or participant ID. Null for mapped users and empty slots.
Stable local identity of a synchronized occurrence. Null for a future assignment without a synchronized identity.
Inclusive start of this assignment interval in UTC.
Exclusive end of this assignment interval in UTC.
Mapped Slack user ID. Null for unmapped participants and explicit empty slots.
Distinct provider participant IDs among current user assignments.
Distinct current responders, deduplicated by Slack user ID when mapped and provider participant ID otherwise.
Current assignments that the provider explicitly leaves unassigned.
Inclusive start of the saved provider snapshot. Check state before using its coverage.
Exclusive end of the saved provider snapshot. Later coverage is unknown.
Last provider read failure code, or null when none is recorded. Check state and the read timestamps for current freshness.
Time of the last failed provider read, or null when none is recorded.
Time of the last successful provider read, or null when none is recorded.
Next known boundary after asOfUtc, or null when none is known. Stale data supplies known ends only, without future starts.
object
UTC instant of the assignment boundary.
Current assignments whose end is later than atUtc.
One external assignment interval, including an explicitly unassigned slot.
object
Cell holding the synchronized assignment, or null for a future assignment without a stored cell.
Provider metadata for this assignment.
object
Assignment member kind: user or empty.
Provider end of the occurrence in UTC.
Original provider start of the occurrence in UTC.
Provider override ID for an override source.
Provider participant ID for a user assignment. Null for an empty slot.
Provider rotation ID for a rotation or rotation-override source.
Provider custom-shift ID for a custom-shift or custom-shift-override source.
Provider source type: schedule_rotation, custom_shift, schedule_rotation_override or custom_shift_override.
Provider email address when available. Null for explicit empty slots or when no email is available.
Display label for an unmapped participant: provider name, email address or participant ID. Null for mapped users and empty slots.
Stable local identity of a synchronized occurrence. Null for a future assignment without a synchronized identity.
Inclusive start of this assignment interval in UTC.
Exclusive end of this assignment interval in UTC.
Mapped Slack user ID. Null for unmapped participants and explicit empty slots.
Current assignments ending at atUtc.
One external assignment interval, including an explicitly unassigned slot.
object
Cell holding the synchronized assignment, or null for a future assignment without a stored cell.
Provider metadata for this assignment.
object
Assignment member kind: user or empty.
Provider end of the occurrence in UTC.
Original provider start of the occurrence in UTC.
Provider override ID for an override source.
Provider participant ID for a user assignment. Null for an empty slot.
Provider rotation ID for a rotation or rotation-override source.
Provider custom-shift ID for a custom-shift or custom-shift-override source.
Provider source type: schedule_rotation, custom_shift, schedule_rotation_override or custom_shift_override.
Provider email address when available. Null for explicit empty slots or when no email is available.
Display label for an unmapped participant: provider name, email address or participant ID. Null for mapped users and empty slots.
Stable local identity of a synchronized occurrence. Null for a future assignment without a synchronized identity.
Inclusive start of this assignment interval in UTC.
Exclusive end of this assignment interval in UTC.
Mapped Slack user ID. Null for unmapped participants and explicit empty slots.
Assignments starting at atUtc, available only from a fresh provider snapshot.
One external assignment interval, including an explicitly unassigned slot.
object
Cell holding the synchronized assignment, or null for a future assignment without a stored cell.
Provider metadata for this assignment.
object
Assignment member kind: user or empty.
Provider end of the occurrence in UTC.
Original provider start of the occurrence in UTC.
Provider override ID for an override source.
Provider participant ID for a user assignment. Null for an empty slot.
Provider rotation ID for a rotation or rotation-override source.
Provider custom-shift ID for a custom-shift or custom-shift-override source.
Provider source type: schedule_rotation, custom_shift, schedule_rotation_override or custom_shift_override.
Provider email address when available. Null for explicit empty slots or when no email is available.
Display label for an unmapped participant: provider name, email address or participant ID. Null for mapped users and empty slots.
Stable local identity of a synchronized occurrence. Null for a future assignment without a synchronized identity.
Inclusive start of this assignment interval in UTC.
Exclusive end of this assignment interval in UTC.
Mapped Slack user ID. Null for unmapped participants and explicit empty slots.
Why there is no usable answer: switchedOff (the rotation is off, nobody is on duty), bindingMissing (no binding to the partner’s schedule), notReadYet (no successful read yet) or snapshotNotCurrent (the last read does not cover asOfUtc). Null when the summary answers. With a reason set, current is empty and nobody is claimed to be assigned.
Number of current assignments, including explicit empty slots. This is an assignment count, not a staffing target.
Freshness: fresh, stale or unavailable. Fresh data covers asOfUtc, agrees with synchronized assignments and has no failed read at or after the last success.
Current user assignments without a Slack mapping. Duplicate assignments count separately.
Who takes each seat next, one entry per running seat of a native rotation, earliest start first, ties in window order and then lane order. A seat whose window is shut lists the person who comes back when it opens (comingBack); otherwise the person its next hand-over deals. Absences are not resolved, since the scheduler skips somebody who is away only when it deals. Empty for a randomised rotation, which draws at the hand-over, for a switched-off rotation, and for a provider-owned one (read externalAssignments).
The person who takes one seat next, and when.
object
Cell the person takes.
Whether this is the seat’s holder resuming when a shut window opens, rather than a new person being dealt. Read since as a hand-over only where this is false.
Lane containing the cell.
Lane name, when available.
When the person takes the seat in UTC: the window’s next hand-over, or the moment it opens where the same person is coming back. Null where the window has no computed firing (a manual one).
Their position in the native turn order.
When their turn ends in UTC, where the window has a hand-over after that.
Slack user ID of the person who takes the seat.
Window containing the cell.
Window name, when available.
Why nobody is on call: nobody-on-call-unplanned when a running place is open and has nobody in it, nobody-on-call-as-arranged when every running place is shut by its hours. The two spellings the duty history uses. Absent while any place is live, even if another lane has no one: an empty onCall with no reason here is a person with no Slack identity, so read externalAssignments or unmappedExternalDuty. Places a downgrade stopped count for neither.
Current mapped Slack assignments. An empty list does not establish a coverage gap: check externalAssignments or unmappedExternalDuty.
One current mapped Slack assignment. A user can appear more than once when they hold multiple assignments.
object
Cell holding this assignment.
Exclusive end in UTC of this stretch of cover: the window closing, or the turn ending if that comes first. Null while nothing bounds the stretch.
Lane containing the cell. Lanes for external assignments do not identify provider roles.
Lane name, when available.
Assignment start in UTC, when known.
Members skipped for absence when this assignment began.
A member skipped because of an absence at assignment time.
object
Absence start in UTC, when known.
Absence source: googleCalendar or internalAvailability. Null when the source is unknown.
Absence end in UTC, when known.
Slack user ID of the skipped member.
Position in the native turn order. External assignments have no native turn order.
When this person’s turn ends in UTC: the next hand-over of the seat, which can be later than coveredUntil when the window closes first. Null where nothing hands the seat over.
Slack user ID of the person on duty.
Window containing the cell. External assignment windows do not define provider recurrence.
Window name, when available.
Rotation ID.
Single unmapped duty for an external schedule without externalAssignments. Null when externalAssignments is present.
object
Provider email address.
Provider display name, when available.
Exclusive assignment end in UTC, when known.
Directory records for current mapped Slack users and skipped members when ?expand=users is requested. Null otherwise. Expansion disables ETag validation.
A Slack user, as Round Robin knows them.
object
The person’s Slack avatar, at 192px.
Null when the install was never granted users:read.email, not only when unknown.
The Slack user id.
Deactivated in Slack, or gone from the workspace. These people are still answered rather than hidden, so an id a rotation still names resolves to something you can render.
A Slack Connect person: visible through a shared channel, never a member of the workspace.
The workspace that owns this person’s directory entry, which under Enterprise Grid can differ from the calling key’s workspace.
The person’s Slack time zone, as an IANA identifier (Europe/Rome). Absent when Round Robin has not seen one for them.
The Slack user group kept in sync with whoever is on call.
How many places on this rotation have nobody on them at all.
Whether every member of the workspace can see the rotation.
The lists this rotation deals from, each in the order this rotation deals it.
A list this rotation deals from, in the order this rotation deals it.
object
The list’s name. Absent when the list could not be read.
The turn the next handover deals from.
The turn order: who is dealt, and in what order.
One position in a turn order.
object
Set when the member is in the order by way of a user group.
The list this order belongs to. Absent on a rotation whose people are not on a shared list yet.
How many lanes are running, which is how many people hold the shift at once.
Whether days the cadence skips (weekends, national holidays) count as time the rotation is not covered. One switch for the whole rotation, read into every window’s own reading.
The template the topic is written from, or null to use Round Robin’s own wording. Shares its placeholders with the message templates, which are not part of this version.
The columns of the grid: covered hours, a time zone, and a handover cadence.
A column of the grid: when the rotation is covered, and how often duty changes hands there.
object
Whether the window restricts nothing: open the whole week, every week.
How often duty changes hands in this column.
object
The countries whose weekends and holidays the skips are read from.
Set for dayOfMonth.
Set for dayOfWeek and nthWeekdayOfMonth.
Set for daysOfWeekList.
The next hand-overs this window has already scheduled. For anything further out, ask for a window from GET /v1/rotations/{rotationId}/schedule.
Set for external: which partner drives the rotation. One of pagerDuty, jsm for Jira Service Management, or none when the rotation is external but no partner is linked yet.
How many units of the cadence’s own kind sit between two hand-overs.
When the cadence starts, in its own time zone.
The time zone the cadence was configured with, as its own identifier (Europe/Rome). Never rewritten to the tzdb canonical name a linked city shares.
Set for daily: the times of day it hands over at.
One of dayOfWeek, daysOfWeekList, dayOfMonth, nthWeekdayOfMonth, daily, workday, manual or external. Fields that mean nothing for the type are absent rather than defaulted, so test for presence rather than for a zero.
Set for nthWeekdayOfMonth: which occurrences in the month, 1 through 5.
The repeating week this window is open for, as stored. Empty means the whole week.
One stretch of the coverage week, which may run past midnight into the next day.
object
A weekday name, monday through sunday.
A time of day, HH:mm.
Whether the window is open at the moment of the response.
The one zone this window’s covered hours are expressed in, as its own identifier (Europe/Rome). Never rewritten to the tzdb canonical name a linked city shares. Empty on a manual rotation, which has no cadence and so no zone to express one in.
Examplegenerated
{ "cells": [ { "holder": { "coveredUntil": "2026-04-15T12:00:00Z", "externalUser": { "email": "example", "name": "example" }, "since": "2026-04-15T12:00:00Z", "skippedForAbsence": [ { "from": "2026-04-15T12:00:00Z", "source": "example", "until": "2026-04-15T12:00:00Z", "userId": "example" } ], "turn": 1, "turnEnds": "2026-04-15T12:00:00Z", "userId": "example", "waiting": true }, "id": "example", "laneId": "example", "rosterId": "example", "stopped": true, "windowId": "example" } ], "channelSettings": [ { "channelId": "example", "postsMessages": true, "syncsTopic": true } ], "channels": [ "example" ], "code": "example", "createdAt": "2026-04-15T12:00:00Z", "description": "example", "doubleCover": true, "enableTopic": true, "enabled": true, "heldSeats": 1, "id": "example", "isGrid": true, "lanes": [ { "id": "example", "name": "example" } ], "members": { "userGroups": [ { "userGroupId": "example", "users": [ { "sequenceNumber": 1, "userId": "example" } ] } ], "users": [ { "sequenceNumber": 1, "userId": "example" } ] }, "mode": "example", "name": "example", "onCall": { "externalAssignments": { "asOfUtc": "2026-04-15T12:00:00Z", "assignedAssignmentCount": 1, "coverage": "example", "current": [ { "cellId": "example", "externalAssignment": { "memberKind": "example", "originalEndUtc": "2026-04-15T12:00:00Z", "originalStartUtc": "2026-04-15T12:00:00Z", "overrideId": "example", "participantId": "example", "rotationId": "example", "shiftId": "example", "sourceType": "example" }, "externalEmail": "example", "externalName": "example", "localAssignmentId": "example", "sinceUtc": "2026-04-15T12:00:00Z", "untilUtc": "2026-04-15T12:00:00Z", "user": "example" } ], "distinctParticipantCount": 1, "distinctResponderCount": 1, "emptyAssignmentCount": 1, "knownFromUtc": "2026-04-15T12:00:00Z", "knownUntilUtc": "2026-04-15T12:00:00Z", "lastReadFailure": "example", "lastReadFailureUtc": "2026-04-15T12:00:00Z", "lastSuccessfulReadUtc": "2026-04-15T12:00:00Z", "nextChange": { "atUtc": "2026-04-15T12:00:00Z", "continuing": [ { "cellId": "example", "externalAssignment": { "memberKind": "example", "originalEndUtc": "2026-04-15T12:00:00Z", "originalStartUtc": "2026-04-15T12:00:00Z", "overrideId": "example", "participantId": "example", "rotationId": "example", "shiftId": "example", "sourceType": "example" }, "externalEmail": "example", "externalName": "example", "localAssignmentId": "example", "sinceUtc": "2026-04-15T12:00:00Z", "untilUtc": "2026-04-15T12:00:00Z", "user": "example" } ], "ending": [ { "cellId": "example", "externalAssignment": { "memberKind": "example", "originalEndUtc": "2026-04-15T12:00:00Z", "originalStartUtc": "2026-04-15T12:00:00Z", "overrideId": "example", "participantId": "example", "rotationId": "example", "shiftId": "example", "sourceType": "example" }, "externalEmail": "example", "externalName": "example", "localAssignmentId": "example", "sinceUtc": "2026-04-15T12:00:00Z", "untilUtc": "2026-04-15T12:00:00Z", "user": "example" } ], "starting": [ { "cellId": "example", "externalAssignment": { "memberKind": "example", "originalEndUtc": "2026-04-15T12:00:00Z", "originalStartUtc": "2026-04-15T12:00:00Z", "overrideId": "example", "participantId": "example", "rotationId": "example", "shiftId": "example", "sourceType": "example" }, "externalEmail": "example", "externalName": "example", "localAssignmentId": "example", "sinceUtc": "2026-04-15T12:00:00Z", "untilUtc": "2026-04-15T12:00:00Z", "user": "example" } ] }, "noAnswerReason": "example", "requiredAssignmentCount": 1, "state": "example", "unmappedAssignmentCount": 1 }, "nextOnCall": [ { "cellId": "example", "comingBack": true, "laneId": "example", "laneName": "example", "since": "2026-04-15T12:00:00Z", "turn": 1, "turnEnds": "2026-04-15T12:00:00Z", "userId": "example", "windowId": "example", "windowName": "example" } ], "nobodyOnCallReason": "example", "onCall": [ { "cellId": "example", "coveredUntil": "2026-04-15T12:00:00Z", "laneId": "example", "laneName": "example", "since": "2026-04-15T12:00:00Z", "skippedForAbsence": [ { "from": "2026-04-15T12:00:00Z", "source": "example", "until": "2026-04-15T12:00:00Z", "userId": "example" } ], "turn": 1, "turnEnds": "2026-04-15T12:00:00Z", "userId": "example", "windowId": "example", "windowName": "example" } ], "rotationId": "example", "unmappedExternalDuty": { "email": "example", "name": "example", "until": "2026-04-15T12:00:00Z" }, "users": [ { "avatarUrl": "example", "displayName": "example", "email": "example", "id": "example", "isDeleted": true, "isExternal": true, "isGuest": true, "realName": "example", "teamId": "example", "timeZone": "example" } ] }, "onDutyUserGroupId": "example", "openSeats": 1, "owners": [ "example" ], "public": true, "rosters": [ { "name": "example", "nextTurn": 1, "order": [ { "turn": 1, "userGroupId": "example", "userId": "example" } ], "rosterId": "example" } ], "runningLanes": 1, "skipsAreOffTime": true, "topicTemplate": "example", "updatedAt": "2026-04-15T12:00:00Z", "windows": [ { "alwaysOpen": true, "cadence": { "countryCodes": [ "example" ], "dayOfMonth": 1, "dayOfWeek": "example", "daysOfWeek": [ "example" ], "nextEvents": [ "2026-04-15T12:00:00Z" ], "partner": "example", "period": 1, "skipNationalHolidays": true, "skipWeekends": true, "startsAt": "2026-04-15T12:00:00Z", "timeZone": "example", "times": [ "example" ], "type": "example", "weeksInMonth": [ 1 ] }, "coverage": [ { "endDay": "example", "endTime": "example", "startDay": "example", "startTime": "example" } ], "currentCoverage": { "endUtc": "2026-04-15T12:00:00Z", "startUtc": "2026-04-15T12:00:00Z" }, "id": "example", "name": "example", "nextCoverage": { "endUtc": "2026-04-15T12:00:00Z", "startUtc": "2026-04-15T12:00:00Z" }, "openNow": true, "timeZone": "example" } ]}Bad Request
object
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Unauthorized
object
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Payment Required
object
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Forbidden
object
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Not Found
object
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Conflict
object
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Precondition Failed
object
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Precondition Required
object
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}