Update heartbeat group

Update the attributes of an existing heartbeat group. Send only the parameters you wish to change (e.g. name)

PATCH https://incidents.betterstack.com/api/v2/heartbeat-groups/{heartbeat_group_id}

URL parameters

heartbeat_group_id

required string

The ID of the heartbeat group you want to update

Headers

Authorization

required string

Bearer $TOKEN

Content-type

string

application/json

Body parameters

paused

boolean

Set to true to pause monitoring for any existing heartbeats in the group — we won't notify you about downtime. Set to false to resume monitoring for any existing heartbeats in the group.

name

string

A name of the group that you can see in the dashboard.

sort_index

integer

The position of the group in your list of heartbeat groups, lower values first. position is accepted as an alias.

200

Returns updated heartbeat group

Response body

{
  "data": {
    "id": "95251342",
    "type": "heartbeat_group",
    "attributes": {
      "name": "Backend services 2",
      "sort_index": 0,
      "created_at": "2020-10-03T20:20:43.547Z",
      "updated_at": "2020-10-03T20:20:43.547Z",
      "team_name": "Test team",
      "paused": false
    }
  }
}

curl --request PATCH \ --url https://incidents.betterstack.com/api/v2/heartbeat-groups/95251342 \ --header "Authorization: Bearer $TOKEN" \ --header 'Content-Type: application/json' \ --data '{ "name": "Backend services 2" }'

Explore documentation

Example cURL - Change name only

Explore documentation

Update heartbeat group

Example cURL - Change name only

Please accept cookies