Explore documentation

Update an existing heartbeat group

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

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

URL parameters

heartbeat_group_id
required string

Headers

Authorization
required string
Content-type
string

Body parameters

period
integer
paused
boolean
name
string
sort_index
integer
200

Response body

{
  "data": {
    "id": "95251342",
    "type": "monitor_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
    }
  }
}

Example cURL - Change name only

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