Sign in

v1

latestOpenAPI 3.1.02026-08-06360288.3 KB
Subscribers

Add Subscriber

Add a new subscriber to receive incident and maintenance notifications.

post/subscriber/add

Headers

x-api-idstring required
x-api-keystring required

Request body

statuspage_idstring required

ID of the status page

methodstring required

Communication method of subscriber. Valid methods are email, sms, or webhook

addressstring required

Subscriber address (SMS numbers must include country code, e.g., +1)

silentstring

Suppress welcome message: 1 = skip, 0 = send

granularstring

Choose which components and data centers to receive notifications for. Comma-separated list of component_container combinations.

Example request

{
  "address": "alerts@acme-corp.com",
  "granular": "54d44a5bfc9259df1000000f_54d44a42fc9259df10000008,54d44a36fc9259df10000005_54d3162f750e87b398000015",
  "method": "email",
  "silent": "1",
  "statuspage_id": "52e5e0e0873548543700000b"
}

Response

OK

resultboolean
subscriber_idstring

Example response

{
  "result": true,
  "status": {
    "error": "no",
    "message": "OK"
  },
  "subscriber_id": "5511b3cbb066c9d14e000005"
}