Explore documentation

Update an on-call calendar event

Update a single event in the given on-call calendar.

PATCH https://uptime.betterstack.com/api/v2/on-calls/{calendar_id}/events/{event_id}

URL parameters

calendar_id
required string

The ID of the on-call calendar that the event is part of. Use default to refer to the default on-call calendar for the team.

event_id
required string

The ID of the event you want to update.

Headers

Authorization
required string

Bearer $TOKEN

Body parameters

starts_at
date

New start time of the event

ends_at
date

New end time of the event

users
array

List of email addresses of the users that will be on-call during this event

200

Event was updated

Response body

{
  "id": 12345678,
  "starts_at": "2025-01-01T09:45:00Z",
  "ends_at": "2025-01-01T17:00:00",
  "users": [
    "[email protected]"
  ]
}
422

Event was not updated

Response body

{
  "errors": {
    "base": [
      "events ending before today at 00:00 UTC can't be updated or deleted"
    ]
  }
}

Example cURL

Example
curl --request PUT \
  --url "https://uptime.betterstack.com/api/v2/on-calls/default/events/12345678" \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"starts_at":"2025-01-01T09:45:00Z"}'