Subscribers
Add, update and remove Subscribers from your status page. Note that you cannot add subscribers with Slack, MS Teams or Google Chat as these require the subscriber to authorise themselves.
Endpoints
https://api.sorryapp.com/v1/pages/:page_id/subscribers/
https://api.sorryapp.com/v1/pages/:page_id/subscribers/:subscriber_id
Objects
These are the attributes which represent the object, most of which can be posted too and received in response to the available methods.
Properties
- Name
id- Description
The unique identifier for the subscriber
- Name
email- Description
The subscriber's email address, we'll use this address to send them status notices, assuming you have an Email publisher configured on your page.
- Name
phone_number- Description
The subscriber's mobile phone number, including its international country code, we'll use this address to send them status notices, assuming you have an SMS publisher configured on your page.
- Name
first_name- Description
The persons first name, displayed in your subscribers list.
- Name
last_name- Description
The persons first name, displayed in your subscribers list.
- Name
nickname- Description
An alternative name to be used in place of their real name.
- Name
company- Description
The name of the company that the subscriber works for.
- Name
tag_list- Description
A comma separated list of tags you can use to help identify and find subscribers through the API.
- Name
created_at- Description
The date/time the record was created.
- Name
updated_at- Description
The date/time the record was last updated.
- Name
include- Description
components
List subscribers
This endpoint displays a list of all subscribers in a single status page.
Request
curl -X GET https://api.sorryapp.com/v1/pages/12ab34cd/subscribers \
-H "Authorization: Bearer {token}"
Response
{
"response": [
{
"id": 1,
"email": "nic@acme.com",
"phone_number": null,
"slack_webhook_url": null,
"microsoft_teams_url": null,
"notify_by_email": true,
"notify_by_phone_number": false,
"notify_by_slack_webhook_url": false,
"notify_by_legacy_slack_oauth_token": false,
"notify_by_microsoft_teams_url": false,
"notify_by_google_chat_space": false,
"first_name": null,
"last_name": null,
"nickname": null,
"company": null,
"tag_list": [],
"avatar_url": "https://www.gravatar.com/avatar/2d2943a3320aa3b90d830993e5d16b5f",
"created_at": "2025-01-21T14:52:27.826Z",
"updated_at": "2025-01-21T14:52:27.798Z"
}
],
"count": 1
}
Create subscribers
This endpoint allows you to create a new subscriber.
Request
curl -X POST https://api.sorryapp.com/v1/pages/12ab34cd/subscribers \
-d email="joe.bloggs@acme.com" \
-d phone_number="+447712345678" \
-H "Authorization: Bearer {token}"
Response
{
"response": {
"id": 2,
"email": "joe.bloggs@acme.com",
"phone_number": "+447712345678",
"slack_webhook_url": null,
"microsoft_teams_url": null,
"notify_by_email": true,
"notify_by_phone_number": true,
"notify_by_slack_webhook_url": false,
"notify_by_legacy_slack_oauth_token": false,
"notify_by_microsoft_teams_url": false,
"notify_by_google_chat_space": false,
"first_name": null,
"last_name": null,
"nickname": null,
"company": null,
"tag_list": [],
"avatar_url": "https://www.gravatar.com/avatar/71840600a833bc5a951b02cd7eab0ebe",
"created_at": "2025-01-22T16:04:36.696Z",
"updated_at": "2025-01-22T16:04:36.688Z"
}
}
Retrieve a subscriber
This endpoint allows you retrieve a single subscriber.
Request
curl -X POST https://api.sorryapp.com/v1/pages/12ab34cd/subscribers/3 \
-H "Authorization: Bearer {token}"
Response
{
"response": {
"id": 987120,
"email": "jane.doe@@acme.com",
"phone_number": null,
"slack_webhook_url": null,
"microsoft_teams_url": null,
"notify_by_email": true,
"notify_by_phone_number": true,
"notify_by_slack_webhook_url": true,
"notify_by_legacy_slack_oauth_token": false,
"notify_by_microsoft_teams_url": false,
"notify_by_google_chat_space": false,
"first_name": "Jane",
"last_name": "Doe",
"nickname": null,
"company": null,
"tag_list": [],
"avatar_url": "https://www.gravatar.com/avatar/71840600a833bc5a951b02cd7eab0ebe",
"created_at": "2025-01-22T16:04:36.696Z",
"updated_at": "2025-01-22T16:04:36.688Z"
}
}
Update subscriber
This endpoint allows you to update a single subscriber.
Request
curl -X POST https://api.sorryapp.com/v1/pages/12ab34cd/subscribers/2 \
-d first_name="Joseph" \
-d last_name="Bloggs" \
-H "Authorization: Bearer {token}"
Response
{
"response": {
"id": 2,
"email": "joe.bloggs@acme.com",
...
"first_name": "Joseph",
"last_name": "Bloggs",
...
"created_at": "2025-01-22T16:04:36.696Z",
"updated_at": "2025-01-22T16:15:42.489Z"
}
}
Delete subscriber
This endpoint allows you to delete the status page, including all notices, components and subscribers.
Request
curl -X DELETE https://api.sorryapp.com/v1/pages/12ab34cd/subscribers/2 \
-H "Authorization: Bearer {token}"