Subscribers API Reference

Get subscribers

Endpoint:

GET /v1/:page_id/subscribers?page=:page&per_page=:per_page

• The default page number is 1.
• The default per_page number is 50 and the maximum is 100 items per page.

Example response

[
  {
    "id": "ckggwtsf18q760950wplqqka7",
    "email": "ali@instatus.com",
    "phone": null,
    "webhook": null,
    "webhookEmail": null,
    "confirmed": false,
    "all": true,
    "components": []
  },
  {
    "id": "ckgurryh6lcyu0946f3bci43n",
    "email": null,
    "phone": "5417543010"
    "webhook": null,
    "webhookEmail": null,
    "confirmed": false,
    "all": true,
    "components": []
  }
]

Add a subscriber

Endpoint:

POST /v1/:page_id/subscribers

Example request

{
  "email": "sarah@instatus.com",
  "all": true,
  "autoConfirm": false // set to true to skip confirmation emails (paid feature)
}

Example response

{
  "id": "ckguumthplm400946ggcxn0x6",
  "email": "sarah@instatus.com",
  "site": {
    "id": "ckg8atg2ro3eh0a35s5v86wrn",
    "name": "Test",
    "logoUrl": null,
    "subdomain": "test",
    "publicEmail": null,
    "language": "en"
  }
}

Subscribe to specific components

Example request

{
  "email": "adam@instatus.com",
  "all": false,
  "components": ["cl2xv23rl0119e7jlk2mweepd"],
  "autoConfirm": false // set to true to skip confirmation emails (paid feature)
}

Example response

{
  "id": "cl34vm85w01422bjluflwgewx",
  "email": "adam@instatus.com",
  "site": {
    "id": "ckg8atg2ro3eh0a35s5v86wrn",
    "name": "Test",
    "logoUrl": null,
    "subdomain": "test",
    "publicEmail": null,
    "language": "en"
  }
}

Remove a subscriber

Endpoint:

DELETE /v1/:page_id/subscribers/:subscriber_id