Generated by API Evangelist
Written by API Evangelist tooling for Checkly's API. It is a proposal applied on top of the contract, not a document Checkly publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Checkly Public Status Pages V3 Subscribers API
version: 1.0.0
extends: openapi/checkly-status-pages-v3-subscribers-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/v3/status-pages/{statusPageId}/subscribers'].get
update:
x-apievangelist-phrasing:
intent: List subscribers of a v3 status page
effect: read
questions:
- Who has subscribed to email updates from my status page?
- Can I list only unverified status page subscribers?
instructions:
- text: List subscribers of status page {statusPageId}.
slots:
statusPageId: path.statusPageId
- text: Show {status} subscribers of status page {statusPageId}.
slots:
status: query.status
statusPageId: path.statusPageId
method: generated
generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/subscribers/bulk'].post
update:
x-apievangelist-phrasing:
intent: Bulk-subscribe emails to a v3 status page
effect: write
questions:
- How do I import a list of customer emails as status page subscribers?
- Can I add subscribers without sending them confirmation emails?
- How many addresses can I subscribe in one go?
instructions:
- text: Subscribe {subscriptions} to status page {statusPageId}.
slots:
subscriptions: requestBody.subscriptions
statusPageId: path.statusPageId
- text: 'Add {subscriptions} to status page {statusPageId} as already verified: {autoVerify}.'
slots:
subscriptions: requestBody.subscriptions
statusPageId: path.statusPageId
autoVerify: requestBody.autoVerify
method: generated
generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/subscribers/{subscriberId}'].delete
update:
x-apievangelist-phrasing:
intent: Remove a status page subscriber
effect: destructive
questions:
- How do I unsubscribe someone from my status page?
- Can I delete one subscriber from a v3 status page?
instructions:
- text: Remove subscriber {subscriberId} from status page {statusPageId}.
slots:
subscriberId: path.subscriberId
statusPageId: path.statusPageId
- text: Delete status page {statusPageId} subscriber {subscriberId}.
slots:
statusPageId: path.statusPageId
subscriberId: path.subscriberId
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.