Skip to main content
POST
Subscribe multiple email addresses to a v3 status page.

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

statusPageId
string
required

Body

application/json
subscriptions
object[]
required

The subscribers to create (max 100). Addresses already subscribed are skipped.

Required array length: 1 - 100 elements
autoVerify
boolean
default:false

Create the subscribers as verified without sending confirmation emails.

Response

Created

created
integer
required

Subscribers created.

skipped
integer
required

Subscribers skipped because the address was already subscribed.

status
enum<string>
required

The status the created subscribers got.

Available options:
PENDING,
VERIFIED