PUT
/
v1
/
alert-channels
/
{id}
/
subscriptions
Update the subscriptions of an alert channel
curl --request PUT \
  --url https://api.checklyhq.com/v1/alert-channels/{id}/subscriptions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "checkId": "0bbfc00c-44df-46a7-a4d9-ba38deca8bfd",
  "groupId": "null",
  "activated": true
}'
{
  "id": 1,
  "checkId": "47ccf418-6224-429c-a096-637364249882",
  "groupId": "null",
  "activated": true
}

​
Overview

The Update Alert Channel Subscriptions endpoint allows you to manage which checks and check groups are subscribed to receive notifications through a specific alert channel. Common Use Cases:
  • Subscription Management
  • Notification Routing
  • Alert Configuration
  • Monitoring Coverage
Subscriptions determine which checks trigger notifications through this alert channel. You can subscribe individual checks or entire check groups to an alert channel.

Authorizations

​
Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here.

Your API key is like a password: keep it secure!

Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID.

For example, set Authorization header while using cURL:

curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

​
x-checkly-account
string

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

Path Parameters

​
id
integer
required

Body

application/json
​
activated
boolean
required
​
checkId
string

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

Example:

"0bbfc00c-44df-46a7-a4d9-ba38deca8bfd"

​
groupId
number

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

Example:

null

Response

Successful

​
activated
boolean
required
​
id
number
Example:

1

​
checkId
string
Example:

"47ccf418-6224-429c-a096-637364249882"

​
groupId
number
Example:

null