EmailSubscribers
Create email subscriber
Add a single pre-verified email subscriber to a dashboard.
POST /app/subscribers/email/subscribers
Creates one pre-verified email subscriber. Admin-trusted — no verification email is sent.
Request
See API Basics for required headers.
Body
| Field | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Normalized email address |
dashboardId | uuid | Yes | Target dashboard |
componentIds | uuid[] | Yes | At least one component on that dashboard |
locked | boolean | No | Admin-managed flag. When true, blocks dashboard self-service subscribe/manage (for distribution lists) but the address still receives event notifications. Default: false. Always returned in the response. |
Sample request
curl -X POST https://api.statusdashboard.com/app/subscribers/email/subscribers \
-H "Authorization: Bearer bcf847abf5c6:def456" \
-H "Content-Type: application/json" \
-d '{
"email": "alice@acme.com",
"dashboardId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"componentIds": ["b2c3d4e5-f6a7-8901-bcde-f12345678901"]
}'Sample response
Status: 201 Created
{
"subscriber": {
"email": "alice@acme.com",
"dashboardId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"dashboardName": "Acme Status",
"verified": true,
"verifiedAt": "2026-06-01T14:22:00.000Z",
"createdAt": "2026-06-01T14:22:00.000Z",
"updatedAt": "2026-06-01T14:22:00.000Z",
"componentIds": ["b2c3d4e5-f6a7-8901-bcde-f12345678901"],
"paused": false,
"locked": false
}
}Error responses
| Status | When |
|---|---|
400 | Invalid body, or component not on dashboard |
403 | Requires admin or subscriber role, org email feature disabled, or subscriber quota exceeded |
404 | Dashboard not found |
409 | Already subscribed on this dashboard, or a bulk import is in progress |