Create an on-call calendar rotation

Creates an on-call rotation. This creates consecutive on-call events for specified users, rotating through them until reaching the end date. This only creates events that end after 0:00 UTC today and removes any existing non-override events within this range.

POST https://uptime.betterstack.com/api/v2/on-calls/{calendar_id}/rotation

URL parameters

calendar_id

required string

The ID of the on-call calendar you want to create the event for. Use default to refer to the default on-call calendar for the team.

Headers

Authorization

required string

Bearer $TOKEN

Body parameters

users

required array

List of email addresses of users to include in the on-call rotation schedule

rotation_length

required number

The length of the specified rotation period, must be an integer

rotation_period

required string

The rotation period, must be one of: hour, day, week

start_rotations_at

required date

Start time of the rotations

end_rotations_at

required date

End time of the rotations

200

Rotation was created

Response body

{
  "rotation_length": 8,
  "rotation_interval": "hour",
  "start_rotations_at": "2025-02-01T07:00:00.000Z",
  "end_rotations_at": "2027-02-01T07:00:00.000Z",
  "users": [
    "bob@betterstack.com",
    "alice@betterstack.com"
  ]
}

Example cURL

Example

Copied!

curl --request POST \
  --url "https://uptime.betterstack.com/api/v2/on-calls/default/rotation" \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"users": ["bob@betterstack.com", "alice@betterstack.com"], "rotation_length": 8, "rotation_interval": "hour", "start_rotations_at": "2025-02-01T07:00:00Z", "end_rotations_at": "2027-02-01T07:00:00Z"}'

Explore documentation

Create an on-call calendar rotation

Example cURL