sms-suppressions

List SMS suppressions

Returns the suppressions currently stopping your messages, most recent opt-out first. Pass destination to look up one subscriber before sending to them.

A suppression covers one sender and one subscriber, so the same number can appear more than once: opting out of one of your senders does not opt out of the others.

Ended suppressions are excluded. A subscriber who opted back in is reachable again and does not appear in this list.

get/v1/sms/suppressions

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/sms/suppressions
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

destinationstring

Return only suppressions for this exact subscriber number in E.164 form. Prefix matching is unsupported.

originatorstring

Return only suppressions covering this sender.

reason'keyword_stop' | 'carrier_opted_out' | 'manual'

Return only suppressions with this reason:

  • keyword_stop: The subscriber texted a stop keyword to the sender.
  • carrier_opted_out: Their carrier reported the opt-out.
  • manual: Added through the API or dashboard.
limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Paginated list of SMS suppressions.

next_cursorstring nullable required

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursorstring nullable required

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursorstring nullable required

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Example response

{
  "data": [
    {
      "id": "ssu_01krdgeqcxet5s7t44vh8rt9mg",
      "destination": "+15550001234",
      "originator": "+15557654321",
      "source_sms_id": "sms_01krdgeqcxet5s7t44vh8rt9mg",
      "source_end_sms_id": "sms_01krdgeqcxet5s7t44vh8rt9mg"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.