StatusDashboard
SMSSuppression

List SMS suppressions

Retrieve the organization's SMS suppression list (opt-outs and permanent delivery failures).

View Markdown

GET /app/subscribers/sms/suppression

Returns a paginated list of suppressed phone numbers for the organization. Entries are created when a recipient opts out (STOP), when the messaging provider reports a permanent delivery failure, or when a send is rejected because the destination remains on a carrier-level opt-out list.

Requires the admin or subscriber role and the SMS notifications feature entitlement.


Request

See API Basics for required headers.

Query parameters

ParameterTypeRequiredDescription
limitintegerNoMax entries per page. Range: 1–100. Default: 10.
nextTokenstringNoNext-page bookmark from the previous response — pass unchanged. See Pagination.
phonestringNoFilter to an exact E.164 phone number (e.g. +14155552671). Must be valid E.164 when provided.

Sample request

curl "https://api.statusdashboard.com/app/subscribers/sms/suppression?phone=%2B14155552671" \
  -H "Authorization: Bearer bcf847abf5c6:def456"

Sample response

Status: 200 OK

{
  "suppressions": [
    {
      "phone": "+14155552671",
      "reason": "opt_out",
      "detail": "Inbound STOP keyword",
      "suppressedAt": "2026-06-26T14:30:00.000Z",
      "lastEventAt": "2026-06-26T14:30:00.000Z"
    }
  ],
  "nextToken": null
}

Response fields

FieldTypeDescription
suppressionsarraySuppression entries for this page.
nextTokenstring | nullNext-page bookmark when more results exist. See Pagination.

Entry fields

Each suppressions[] item:

FieldTypeDescription
phonestringSuppressed number in E.164 format.
reasonstringopt_out, invalid, carrier_blocked, spam, or protect.
detailstring | omittedHuman-readable summary from the event.
suppressedAtstringISO 8601 — first time this number was suppressed.
lastEventAtstringISO 8601 — most recent event for this entry.

Pagination

See Pagination in API Basics. Re-send the same query parameters on every page request.


Retention

Suppression entries do not expire. They remain until removed via DELETE suppression.

See SMS suppression list for how entries are created, what each reason means, and when it is safe to remove a row.


Error responses

StatusWhen
400Invalid query parameters (e.g. malformed phone or nextToken).
403Missing required role, or the SMS notifications feature is not enabled on your plan.

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.