v2

latestSwagger 2.02026-07-26109144190.4 KB

Rotations

Update a shift

Update an existing shift within a rotation group.

The shift duration must be 90 days or less. All fields are required (this is a full replacement). The "shifttype" field must be one of: "std" (Standard), "fts" (Follow The Sun), "cstm" (Custom), "pho" (Period Hand Off).

This API may be called a maximum of 2 times per second.

put/api-public/v1/teams/{team}/rotations/{groupId}/{shiftId}

Path parameters

teamstring required

The team slug

groupIdinteger required

The rotation group ID

shiftIdinteger required

The rotation shift ID

Query parameters

skipinteger

Number of weeks to skip for the on-call period preview

countinteger

Number of weeks to show for the on-call period preview

Headers

X-VO-Api-Idstring required

Your API ID

X-VO-Api-Keystring required

Your API Key

Request body

labelstring required

The name of the shift

timezonestring required

The timezone for the shift (e.g. "America/Denver", "Asia/Calcutta")

startinteger required

The start time of the shift in epoch milliseconds

durationinteger required

The duration of the shift in days (must be 90 or less)

shifttype'std' | 'fts' | 'cstm' | 'pho' required

The type of shift. Must be one of: std (Standard), fts (Follow The Sun), cstm (Custom), pho (Period Hand Off)

usernamesstring[]

An optional list of usernames to add to this shift. Only honored when creating shifts inline via the create rotation group endpoint; it is ignored by the add shift and update shift endpoints (use the shift members endpoint to manage members there).

Response

The updated shift with on-call period details

org_slugstring

team_slugstring

rot_idinteger

The shift/rotation ID

group_idinteger

The parent rotation group ID

labelstring

The name of the shift

timezonestring

The timezone of the shift

startinteger

The start time of the shift in epoch milliseconds

durationinteger

The duration of the shift in days

shifttype'std' | 'fts' | 'cstm' | 'pho'

The type of shift: std, fts, cstm, or pho

oncallstring

The username of the currently on-call user

usernamesstring[]

Usernames of the members in this shift