StatusDashboard
SMSSubscribers

Update SMS subscriber

Update component selections or admin-verify a pending SMS subscriber.

View Markdown

PUT /app/subscribers/sms/subscribers/{dashboardId}/{phone}

Updates service selections for a verified SMS subscriber, or admin-verifies a pending subscriber when verify is true.


Path parameters

ParameterTypeDescription
dashboardIduuidDashboard the subscription belongs to
phonestringE.164 subscriber phone (URL-encoded, e.g. %2B14155552671)

Request

See API Basics for required headers.

Body

FieldTypeRequiredDescription
componentIdsuuid[]YesComponent IDs on the dashboard
verifybooleanNoSet to true to activate a pending subscriber

There is no admin-managed (locked) flag for SMS — that concept applies only to email update.

Behavior

Subscriber statusverifycomponentIdsResult
Verifiedomitted or falseAny (may be empty)Update selections; empty array stops notifications (paused: true)
Verifiedtrue400 — already verified
PendingtrueAt least oneAdmin-verify; no verification text sent
Pendingomitted or false400 — set verify to true

Pending subscribers already count toward quota while pending; verifying does not consume an additional slot.


Sample request — update verified

curl -X PUT "https://api.statusdashboard.com/app/subscribers/sms/subscribers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/%2B14155552671" \
  -H "Authorization: Bearer bcf847abf5c6:def456" \
  -H "Content-Type: application/json" \
  -d '{
    "componentIds": ["b2c3d4e5-f6a7-8901-bcde-f12345678901", "c3d4e5f6-a7b8-9012-cdef-123456789012"]
  }'

Sample request — verify pending

curl -X PUT "https://api.statusdashboard.com/app/subscribers/sms/subscribers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/%2B14155552671" \
  -H "Authorization: Bearer bcf847abf5c6:def456" \
  -H "Content-Type: application/json" \
  -d '{
    "componentIds": ["b2c3d4e5-f6a7-8901-bcde-f12345678901"],
    "verify": true
  }'

Sample response

Status: 200 OK

{
  "subscriber": {
    "phone": "+1 415 555 2671",
    "normalizedPhone": "+14155552671",
    "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-01T15:10:00.000Z",
    "componentIds": ["b2c3d4e5-f6a7-8901-bcde-f12345678901", "c3d4e5f6-a7b8-9012-cdef-123456789012"],
    "paused": false
  }
}

Error responses

StatusWhen
400Invalid path or body, invalid component, or pending update without verify: true
403Requires admin or subscriber role, feature disabled, or quota exceeded
404Subscriber or dashboard not found
409Phone already verified on this dashboard

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.