Ask an address to subscribe. It stays pending until its owner clicks the emailed link.
POST
/status_page/{status_page_id}/subscriber
const url = 'https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/subscriber';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"email":"example","component_ids":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"kinds":["incident"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/subscriber \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "email": "example", "component_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "kinds": [ "incident" ] }'Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” status_page_id
required
string format: uuid
Status page identifier
Request Body required
Section titled “Request Body required ” Media type application/json
object
email
required
string
component_ids
Components (their layout id) whose notices the address gets. Absent or empty means all.
Array<string>
kinds
Kinds of update it gets. Absent, empty or both means all.
Array<string>
Responses
Section titled “ Responses ”Confirmation sent, or nothing to send
Media type application/json
object
email
required
string
result
required
string
Example
{ "result": "confirmation_sent"}Not a plain email address, or a component not on this page
Missing or invalid authentication
Status page not found
The page already holds 1000 subscribers
Too many confirmation emails this hour
Internal server error