Skip to content

Change a list

PATCH
/v1/rotations/{rotationId}/lists/{listId}
curl --request PATCH \
--url https://api.roundrobinbot.eu/v1/rotations/example/lists/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json-patch+json' \
--header 'If-Match: example' \
--data '{ "name": "example", "userIds": [ "example" ], "userGroupIds": [ "example" ] }'

Renames a list, replaces the people named on it, replaces the Slack user groups it draws on, or any of the three. Only the fields you send change, and the rotation’s other lists are not touched. The order of userIds is the order people are dealt. Answers with the rotation and a fresh ETag. A change that would put the workspace over its plan’s people limit answers 402 with nothing changed. A person who cannot be found in the workspace answers 409 with the code rotationMemberDoesNotExist. A rotation bound to PagerDuty or Jira Service Management answers 409 with the code external_rotation_is_read_only.

rotationId
required
string
listId
required
string
If-Match
required
string

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

One of:
null
Examplegenerated
{
"name": "example",
"userIds": [
"example"
],
"userGroupIds": [
"example"
]
}

OK

Media typeapplication/json

A rotation: the grid of duties it runs, who is in it, and who is on duty in each lane and window right now.

object
id
string
name
string
description
null | string
code

The short code the rotation answers to in Slack.

null | string
enabled
boolean
public

Whether every member of the workspace can see the rotation.

boolean
mode

manual, auto or external.

string
runningLanes

How many lanes are running, which is how many people hold the shift at once.

integer format: int32
heldSeats

How many lanes in windows on this rotation have somebody on duty right now.

integer format: int32
openSeats

How many lanes in windows on this rotation have nobody on them at all.

integer format: int32
isGrid

Whether this rotation has more than one lane or window to be on duty in at once.

boolean
doubleCover

Whether one person may be on duty in two lanes at once when the list behind them is too short to fill both.

boolean
skipsAreOffTime

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.

boolean
owners
Array<string>
channels

The channels this rotation posts in: the same facts as channelSettings, flattened to the ids that receive duty messages.

Array<string>
channelSettings

Every channel this rotation uses, each saying what Round Robin does in it. Write one with PUT /v1/rotations/{rotationId}/channels/{channelId}.

Array<object>

One Slack channel a rotation uses, and what Round Robin does in it.

object
channelId

The Slack channel id, for example C0123456789.

string
postsMessages

Whether hand-overs, reminders and mentions of this rotation are posted in this channel.

boolean
syncsTopic

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.

boolean
enableTopic

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.

boolean
topicTemplate

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.

null | string
members

Everybody in the rotation: the union across every list it draws on.

object
users

Members added individually.

Array<object>

One member of a rotation.

object
userId
string
sequenceNumber

Where the member sits in the order the lists are built from.

integer format: int32
userGroups

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.

Array<object>

A Slack user group in the rotation, and the people currently in it.

object
userGroupId
string
users
Array<object>

One member of a rotation.

object
userId
string
sequenceNumber

Where the member sits in the order the lists are built from.

integer format: int32
lanes

The rows of the grid: the kinds of duty this rotation runs.

Array<object>

A row of the grid: a kind of duty, such as primary or backend.

object
id
string
name

What the customer calls this lane, and absent until they name it.

null | string
windows

The windows of the grid: covered hours, a time zone, and a handover cadence.

Array<object>

A window of the grid: when the rotation is covered, and how often duty changes hands there.

object
id
string
name
null | string
timeZone

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.

string
coverage

The repeating week this window is open for, as stored. Empty means the whole week.

Array<object>

One stretch of the coverage week, which may run past midnight into the next day.

object
startDay

A weekday name, monday through sunday.

string
startTime

A time of day, HH:mm.

string
endDay
string
endTime
string
alwaysOpen

Whether the window restricts nothing: open the whole week, every week.

boolean
cadence

How often duty changes hands in this window.

object
type

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.

string
timeZone

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.

string
startsAt

When the cadence starts, in its own time zone.

string format: date-time
period

How many units of the cadence’s own kind sit between two hand-overs.

integer format: int32
skipWeekends
boolean
skipNationalHolidays
boolean
countryCodes

The countries whose weekends and holidays the skips are read from.

Array<string>
nextEvents

The next hand-overs this window has already scheduled. For anything further out, ask for a window from GET /v1/rotations/{rotationId}/schedule.

Array<string>
dayOfWeek

Set for dayOfWeek and nthWeekdayOfMonth.

null | string
daysOfWeek

Set for daysOfWeekList.

Array<string> | null
dayOfMonth

Set for dayOfMonth.

null | integer format: int32
weeksInMonth

Set for nthWeekdayOfMonth: which occurrences in the month, 1 through 5.

Array<integer> | null
times

Set for daily: the times of day it hands over at.

Array<string> | null
partner

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.

null | string
openNow

Whether the window is open at the moment of the response.

boolean
currentCoverage
One of:
null
nextCoverage
One of:
null
cells

Every lane crossed with every window, and whoever holds each one.

Array<object>

A lane crossed with a window: where somebody can be on duty.

object
id
string
laneId
string
windowId
string
listId

Which list this lane is dealt from in this window, matching an entry in the rotation’s lists.

null | string
rosterId

Deprecated: use listId, which carries the same value.

null | string
stopped

Whether this lane in this window is defined but not running, because the workspace is not on a paid plan.

boolean
holder
One of:
null
lists

The lists this rotation deals from, each in the order this rotation deals it.

Array<object>

A list this rotation deals from, in the order this rotation deals it.

object
listId

The list this order belongs to. Absent on a rotation whose people are not on a shared list yet.

null | string
name

The list’s name. Absent when the list could not be read.

null | string
order

The turn order: who is dealt, and in what order.

Array<object>

One position in a turn order.

object
userId
string
userGroupId

Set when the member is in the order by way of a user group.

null | string
turn
integer format: int32
nextTurn

The turn the next handover deals from.

integer format: int32
rosters

Deprecated: use lists, which carries the same entries under the name listId.

Array<object>

Deprecated: use lists, whose entries carry the same values under the name listId.

object
rosterId

Deprecated: use listId on lists.

null | string
name

The list’s name. Absent when the list could not be read.

null | string
order

The turn order: who is dealt, and in what order.

Array<object>

One position in a turn order.

object
userId
string
userGroupId

Set when the member is in the order by way of a user group.

null | string
turn
integer format: int32
nextTurn

The turn the next handover deals from.

integer format: int32
onDutyUserGroupId

The Slack user group kept in sync with whoever is on duty.

null | string
onCall

The on-duty resource, embedded, so the common question needs no second call.

object
externalAssignments
One of:
null
rotationId

Rotation ID.

string
nobodyOnCallReason

Why nobody is on duty: nobody-on-call-unplanned when a running lane in an open window has nobody in it, nobody-on-call-as-arranged when every running lane is shut by its hours. The two spellings the duty history uses. Absent while any lane 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. Lanes a downgrade stopped count for neither.

null | string
onCall

Current mapped Slack assignments. An empty list does not establish a coverage gap: check externalAssignments or unmappedExternalDuty.

Array<object>

One current mapped Slack assignment. A user can appear more than once when they hold multiple assignments.

object
userId

Slack user ID of the person on duty.

string
turn

Position in the native turn order. External assignments have no native turn order.

integer format: int32
cellId

Identifier of the lane in a window holding this assignment.

null | string
laneId

The lane. Lanes for external assignments do not identify provider roles.

null | string
laneName

Lane name, when available.

null | string
windowId

The window. External assignment windows do not define provider recurrence.

null | string
windowName

Window name, when available.

null | string
since

Assignment start in UTC, when known.

null | string format: date-time
coveredUntil

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.

null | string format: date-time
turnEnds

When this person’s turn ends in UTC: the next hand-over of the lane in its window, which can be later than coveredUntil when the window closes first. Null where nothing hands it over.

null | string format: date-time
skippedForAbsence

Members skipped for absence when this assignment began.

Array<object>

A member skipped because of an absence at assignment time.

object
userId

Slack user ID of the skipped member.

string
from

Absence start in UTC, when known.

null | string format: date-time
until

Absence end in UTC, when known.

null | string format: date-time
source

Absence source: googleCalendar or internalAvailability. Null when the source is unknown.

null | string
nextOnCall

Who takes each lane next, one entry per running lane in each window of a native rotation, earliest start first, ties in window order and then lane order. A lane 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. For a window nothing fires on, the entry is what a rotate of the whole rotation does: a lane nobody on its list is free to take has no entry and is listed in seatsWithNobodyFree. Empty for a randomised rotation, which draws at the hand-over, for a switched-off rotation, and for a provider-owned one (read externalAssignments).

Array<object> | null

The person who takes one lane in a window next, and when.

object
userId

Slack user ID of the person who takes the lane.

string
turn

Their position in the native turn order.

integer format: int32
cellId

Identifier of the lane in a window the person takes.

string
laneId

The lane.

string
laneName

Lane name, when available.

null | string
windowId

The window.

string
windowName

Window name, when available.

null | string
since

When the person takes the lane 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).

null | string format: date-time
turnEnds

When their turn ends in UTC, where the window has a hand-over after that.

null | string format: date-time
comingBack

Whether this is the lane’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.

boolean
seatsWithNobodyFree

The lanes in a window that a rotate leaves as they are, because nobody on their list is free: everyone on the list either holds this lane or stays on duty in a lane the rotate does not change. Such a lane has no entry in nextOnCall. Listed only for a window nothing fires on, which is handed over by a rotate; empty for a window that hands over on a schedule, for a randomised rotation, for a switched-off rotation, and for a provider-owned one.

Array<object> | null

A lane in a window that a rotate leaves as it is, because nobody on its list is free to take it.

object
cellId

Identifier of the lane in a window, the same cellId the on-call entries carry.

string
laneId

The lane.

string
laneName

Lane name, when available.

null | string
windowId

The window.

string
windowName

Window name, when available.

null | string
unmappedExternalDuty
One of:
null
users

Directory records for current mapped Slack users and skipped members when ?expand=users is requested. Null otherwise. Expansion disables ETag validation.

Array<object> | null

A Slack user, as Round Robin knows them.

object
id

The Slack user id.

string
teamId

The workspace that owns this person’s directory entry, which under Enterprise Grid can differ from the calling key’s workspace.

string
displayName
null | string
realName
null | string
email

Null when the install was never granted users:read.email, not only when unknown.

null | string
isGuest
boolean
isExternal

A Slack Connect person: visible through a shared channel, never a member of the workspace.

boolean
isDeleted

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 person nothing in the workspace names any more (no rotation, role, partner schedule mapping, or open cover, swap or arrangement) is removed 30 days after they left. Their id then answers 404 on this endpoint, on the availability of a person and on a person’s shifts.

boolean
avatarUrl

The person’s Slack avatar, at 192px.

null | string
timeZone

The person’s Slack time zone, as an IANA identifier (Europe/Rome). Absent when Round Robin has not seen one for them.

null | string
createdAt
string format: date-time
updatedAt
string format: date-time
Examplegenerated
{
"id": "example",
"name": "example",
"description": "example",
"code": "example",
"enabled": true,
"public": true,
"mode": "example",
"runningLanes": 1,
"heldSeats": 1,
"openSeats": 1,
"isGrid": true,
"doubleCover": true,
"skipsAreOffTime": true,
"owners": [
"example"
],
"channels": [
"example"
],
"channelSettings": [
{
"channelId": "example",
"postsMessages": true,
"syncsTopic": true
}
],
"enableTopic": true,
"topicTemplate": "example",
"members": {
"users": [
{
"userId": "example",
"sequenceNumber": 1
}
],
"userGroups": [
{
"userGroupId": "example",
"users": [
{
"userId": "example",
"sequenceNumber": 1
}
]
}
]
},
"lanes": [
{
"id": "example",
"name": "example"
}
],
"windows": [
{
"id": "example",
"name": "example",
"timeZone": "example",
"coverage": [
{
"startDay": "example",
"startTime": "example",
"endDay": "example",
"endTime": "example"
}
],
"alwaysOpen": true,
"cadence": {
"type": "example",
"timeZone": "example",
"startsAt": "2026-04-15T12:00:00Z",
"period": 1,
"skipWeekends": true,
"skipNationalHolidays": true,
"countryCodes": [
"example"
],
"nextEvents": [
"2026-04-15T12:00:00Z"
],
"dayOfWeek": "example",
"daysOfWeek": [
"example"
],
"dayOfMonth": 1,
"weeksInMonth": [
1
],
"times": [
"example"
],
"partner": "example"
},
"openNow": true,
"currentCoverage": {
"startUtc": "2026-04-15T12:00:00Z",
"endUtc": "2026-04-15T12:00:00Z"
},
"nextCoverage": {
"startUtc": "2026-04-15T12:00:00Z",
"endUtc": "2026-04-15T12:00:00Z"
}
}
],
"cells": [
{
"id": "example",
"laneId": "example",
"windowId": "example",
"listId": "example",
"rosterId": "example",
"stopped": true,
"holder": {
"userId": "example",
"externalUser": {
"email": "example",
"name": "example"
},
"turn": 1,
"waiting": true,
"since": "2026-04-15T12:00:00Z",
"coveredUntil": "2026-04-15T12:00:00Z",
"turnEnds": "2026-04-15T12:00:00Z",
"skippedForAbsence": [
{
"userId": "example",
"from": "2026-04-15T12:00:00Z",
"until": "2026-04-15T12:00:00Z",
"source": "example"
}
]
}
}
],
"lists": [
{
"listId": "example",
"name": "example",
"order": [
{
"userId": "example",
"userGroupId": "example",
"turn": 1
}
],
"nextTurn": 1
}
],
"rosters": [
{
"rosterId": "example",
"name": "example",
"order": [
{
"userId": "example",
"userGroupId": "example",
"turn": 1
}
],
"nextTurn": 1
}
],
"onDutyUserGroupId": "example",
"onCall": {
"externalAssignments": {
"asOfUtc": "2026-04-15T12:00:00Z",
"state": "example",
"noAnswerReason": "example",
"coverage": "example",
"lastSuccessfulReadUtc": "2026-04-15T12:00:00Z",
"lastReadFailureUtc": "2026-04-15T12:00:00Z",
"knownFromUtc": "2026-04-15T12:00:00Z",
"knownUntilUtc": "2026-04-15T12:00:00Z",
"current": [
{
"localAssignmentId": "example",
"cellId": "example",
"user": "example",
"externalName": "example",
"externalEmail": "example",
"sinceUtc": "2026-04-15T12:00:00Z",
"untilUtc": "2026-04-15T12:00:00Z",
"externalAssignment": {
"memberKind": "example",
"participantId": "example",
"sourceType": "example",
"rotationId": "example",
"shiftId": "example",
"overrideId": "example",
"originalStartUtc": "2026-04-15T12:00:00Z",
"originalEndUtc": "2026-04-15T12:00:00Z"
}
}
],
"requiredAssignmentCount": 1,
"assignedAssignmentCount": 1,
"lastReadFailure": "example",
"distinctResponderCount": 1,
"distinctParticipantCount": 1,
"unmappedAssignmentCount": 1,
"emptyAssignmentCount": 1,
"nextChange": {
"atUtc": "2026-04-15T12:00:00Z",
"starting": [
{
"localAssignmentId": "example",
"cellId": "example",
"user": "example",
"externalName": "example",
"externalEmail": "example",
"sinceUtc": "2026-04-15T12:00:00Z",
"untilUtc": "2026-04-15T12:00:00Z",
"externalAssignment": {
"memberKind": "example",
"participantId": "example",
"sourceType": "example",
"rotationId": "example",
"shiftId": "example",
"overrideId": "example",
"originalStartUtc": "2026-04-15T12:00:00Z",
"originalEndUtc": "2026-04-15T12:00:00Z"
}
}
],
"continuing": [
{
"localAssignmentId": "example",
"cellId": "example",
"user": "example",
"externalName": "example",
"externalEmail": "example",
"sinceUtc": "2026-04-15T12:00:00Z",
"untilUtc": "2026-04-15T12:00:00Z",
"externalAssignment": {
"memberKind": "example",
"participantId": "example",
"sourceType": "example",
"rotationId": "example",
"shiftId": "example",
"overrideId": "example",
"originalStartUtc": "2026-04-15T12:00:00Z",
"originalEndUtc": "2026-04-15T12:00:00Z"
}
}
],
"ending": [
{
"localAssignmentId": "example",
"cellId": "example",
"user": "example",
"externalName": "example",
"externalEmail": "example",
"sinceUtc": "2026-04-15T12:00:00Z",
"untilUtc": "2026-04-15T12:00:00Z",
"externalAssignment": {
"memberKind": "example",
"participantId": "example",
"sourceType": "example",
"rotationId": "example",
"shiftId": "example",
"overrideId": "example",
"originalStartUtc": "2026-04-15T12:00:00Z",
"originalEndUtc": "2026-04-15T12:00:00Z"
}
}
]
}
},
"rotationId": "example",
"nobodyOnCallReason": "example",
"onCall": [
{
"userId": "example",
"turn": 1,
"cellId": "example",
"laneId": "example",
"laneName": "example",
"windowId": "example",
"windowName": "example",
"since": "2026-04-15T12:00:00Z",
"coveredUntil": "2026-04-15T12:00:00Z",
"turnEnds": "2026-04-15T12:00:00Z",
"skippedForAbsence": [
{
"userId": "example",
"from": "2026-04-15T12:00:00Z",
"until": "2026-04-15T12:00:00Z",
"source": "example"
}
]
}
],
"nextOnCall": [
{
"userId": "example",
"turn": 1,
"cellId": "example",
"laneId": "example",
"laneName": "example",
"windowId": "example",
"windowName": "example",
"since": "2026-04-15T12:00:00Z",
"turnEnds": "2026-04-15T12:00:00Z",
"comingBack": true
}
],
"seatsWithNobodyFree": [
{
"cellId": "example",
"laneId": "example",
"laneName": "example",
"windowId": "example",
"windowName": "example"
}
],
"unmappedExternalDuty": {
"email": "example",
"name": "example",
"until": "2026-04-15T12:00:00Z"
},
"users": [
{
"id": "example",
"teamId": "example",
"displayName": "example",
"realName": "example",
"email": "example",
"isGuest": true,
"isExternal": true,
"isDeleted": true,
"avatarUrl": "example",
"timeZone": "example"
}
]
},
"createdAt": "2026-04-15T12:00:00Z",
"updatedAt": "2026-04-15T12:00:00Z"
}

Bad Request

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Unauthorized

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Payment Required

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Forbidden

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Conflict

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Precondition Failed

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Precondition Required

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}