Update existing heartbeat

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

PATCH https://betteruptime.com/api/v2/heartbeats/{heartbeat_id}

URL parameters

heartbeat_id
required string

Headers

Authorization
required string
Content-type
String

Body parameters

name
string
period
integer
grace
integer
call
boolean
sms
boolean
email
boolean
push
boolean
team-wait
integer
heartbeat_group_id
string
sort_index
integer
paused
boolean
policy_id
string
200

Response body

{
  "data": {
    "id": "12345",
    "type": "heartbeat",
    "attributes": {
      "url": "https://betteruptime.com/api/v1/heartbeat/abcd1234abcd1234abcd1234",
      "name": "Testing heartbeat, with an update",
      "period": 10800,
      "grace": 300,
      "call": false,
      "sms": false,
      "email": true,
      "push": true,
      "team_wait": 180,
      "heartbeat_group_id": null,
      "sort_index": null,
      "paused_at": null,
      "created_at": "2020-05-05T11:41:49.327Z",
      "updated_at": "2020-12-10T15:00:15.089Z"
    }
  }
}

Example cURL

curl --request PATCH \
  --url https://betteruptime.com/api/v2/heartbeats/12345 \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Testing heartbeat, with an update"
}'
Copied!