v2

latestOpenAPI 3.0.02026-07-261859071.2 MB

Alert channels

Update the subscriptions of an alert channel

Update the subscriptions of an alert channel. Use this to add a check to an alert channel so failure and recovery alerts are send out for that check. Note: when passing the subscription object, you can only specify a "checkId" or a "groupId, not both.

put/v1/alert-channels/{id}/subscriptions

Path parameters

idinteger required

Headers

x-checkly-accountstring

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Request body

checkIdstring nullable

You can either pass a checkId or a groupId, but not both.

groupIdnumber nullable

You can either pass a checkId or a groupId, but not both.

activatedboolean required

Example request

{
  "checkId": "0bbfc00c-44df-46a7-a4d9-ba38deca8bfd"
}

Response

Successful

idnumber

checkIdstring nullable

groupIdnumber nullable

activatedboolean required

Example response

{
  "id": 1,
  "checkId": "47ccf418-6224-429c-a096-637364249882"
}