StatusDashboard
DashboardsSubscriptions

Update subscription config

Replace the subscription channel configuration for a dashboard.

View Markdown

PUT /app/dashboards/{id}/subscriptions

Replaces the full subscription channel configuration for a dashboard. All six channel objects must be included in every request.

Toggles store customer intent per dashboard. You may enable a channel even when your plan does not currently include it — the setting is saved and takes effect automatically when the plan includes that channel. Plan entitlement and subscriber capacity are enforced on the status dashboard at runtime, not on this endpoint.


Path parameters

ParameterDescription
idThe UUID of the dashboard.

Request

See API Basics for required headers.

Request body

FieldTypeDescription
email.enabledbooleantrue when visitors should be able to subscribe via email (when plan allows).
sms.enabledbooleantrue when visitors should be able to subscribe via SMS (when plan allows).
whatsapp.enabledbooleantrue when visitors should be able to subscribe via WhatsApp (when plan allows).
webhook.enabledbooleantrue when visitors should be able to subscribe a JSON webhook endpoint (when plan allows).
teams.enabledbooleantrue when visitors should be able to subscribe a Microsoft Teams incoming webhook (when plan allows).
gchat.enabledbooleantrue when visitors should be able to subscribe a Google Chat webhook (when plan allows).

Sample request

curl -X PUT https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890/subscriptions \
  -H "Authorization: Bearer bcf847abf5c6:def456" \
  -H "Content-Type: application/json" \
  -d '{
    "email":    { "enabled": true },
    "sms":      { "enabled": false },
    "whatsapp": { "enabled": false },
    "webhook":  { "enabled": true },
    "teams":   { "enabled": false },
    "gchat":   { "enabled": false }
  }'

Sample response

Status: 200 OK

{
  "email":    { "enabled": true },
  "sms":      { "enabled": false },
  "whatsapp": { "enabled": false },
  "webhook":  { "enabled": true },
  "teams":   { "enabled": false },
  "gchat":   { "enabled": false }
}

Notes

When one or more channels are effectively active, a Subscribe link appears in the action bar of the status dashboard. A channel is active when the per-dashboard toggle is on and the org plan includes that channel (emailEnabled for email; smsEnabled for SMS; whatsappEnabled for WhatsApp; integrations for webhook, Teams, and Google Chat). Plan entitlement alone does not enable a channel.

When a channel is active but the org-wide unique subscriber/endpoint quota has been reached, the Subscribe link remains visible; new signups are rejected at submit time for new contacts or endpoints only:

  • Email: new email addresses are rejected; addresses already in your organization may still subscribe on additional dashboards.
  • SMS / WhatsApp: new phone numbers are rejected; numbers already in your organization may still subscribe on additional dashboards.
  • Webhook / Teams / Google Chat / Slack: new unique endpoints or channels are rejected; endpoints or channels already in your organization may still subscribe on additional dashboards where applicable.

The public GET /dashboard/status response includes a subscriptions object with the effective active state per channel.


Error responses

StatusWhen
400Invalid request body (all five channels are required).
404Dashboard not found or does not belong to the caller's organization.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.