Bulk update on-call schedule events

Replace all current and future on-call events in a single on-call schedule:

Delete all events that start today at 0:00 UTC or later.
Create new events. All newly created events also must start today at 0:00 UTC or later.

PUT https://uptime.betterstack.com/api/v2/on-calls/{schedule_id}/events

URL parameters

schedule_id

required string

The ID of the on-call schedule you want to replace events for. Use default to refer to the default on-call schedule for the team.

Headers

Authorization

required string

Bearer $TOKEN

Body parameters

events

required array

List of events to create. These events will replace all existing future events within this schedule. Past events won't be replaced. Use the same event structure as if you were creating a single event. See example below.

200

The events were saved

Response body

{
  "events": [
    {
      "id": 12345,
      "users": ["tomas@betterstack.com"],
      "starts_at": "2024-09-04T22:00:00Z",
      "ends_at": "2024-09-05T22:00:00Z",
    },
    {
      "id": 23456,
      "users": ["simon@betterstack.com"],
      "starts_at": "2024-09-05T22:00:00Z",
      "ends_at": "2024-09-06T22:00:00Z",
    },
    {
      "id": 34567,
      "users": ["tomas@betterstack.com"],
      "starts_at": "2024-09-06T22:00:00Z",
      "ends_at": "2024-09-07T22:00:00Z",
    }
  ]
}

422

The events were not saved

Response body

{
  "errors": "Sorry, these attributes have unsupported values",
  "allowed_values": {
    "event": {
      "starts_at": [
        "must be today at 00:00 UTC or later"
      ]
    }
  }
}

Example cURL

Example

Copied!

curl --request PUT \
  --url "https://uptime.betterstack.com/api/v2/on-calls/default/events" \
  --header "Authorization: Bearer $TOKEN"
  --header "Content-Type: application/json"
  --data '{
    "events": [
      {
        "users": ["tomas@betterstack.com"],
        "starts_at": "2024-09-04T22:00:00Z",
        "ends_at": "2024-09-05T22:00:00Z"
      },
      {
        "users": ["simon@betterstack.com"],
        "starts_at": "2024-09-05T22:00:00Z",
        "ends_at": "2024-09-06T22:00:00Z"
      },
      {
        "users": ["tomas@betterstack.com"],
        "starts_at": "2024-09-06T22:00:00Z",
        "ends_at": "2024-09-07T22:00:00Z"
      }
    ]
  }'

Remove on-call schedule event

Response attributes

Explore documentation

Bulk update on-call schedule events

Example cURL