Sign inGet Started

List Apple Messages for Business suppressions

GET
/v1/amb/suppressions
const result = await bird.amb.suppressions.list({
  business_account_id: "abz_01krdgeqcxet5s7t44vh8rt9mg",
  limit: 2,
});
console.log(result);
Response200
{
  "data": [
    {
      "id": "asp_01krdgeqcxet5s7t44vh8rt9mg",
      "business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
      "address": "+15551234567",
      "address_type": "opaque_user_id",
      "reason": "manual",
      "origin": "user",
      "applies_to": "all",
      "source_message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
      "source_event_id": "aev_01krdgeqcxet5s7t44vh8rt9mg",
      "ended_reason": "user",
      "source_end_message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns the suppressions currently stopping your messages, most recent first by effective_at. Pass address to look up one customer before messaging them, and business_account_id to narrow to one account.

A suppression covers one address for one business account, or for every account in the workspace when business_account_id is null. Filtering by business_account_id returns that account's suppressions together with the workspace-wide ones that stop it too.

Ended suppressions are excluded. A customer who returned to a conversation they had closed is reachable again and does not appear in this list.

Query Parameters

business_account_idstring

Return only suppressions covering this business account, including the workspace-wide ones that stop it too. Omit for every account in the workspace.

addressstring

Return only suppressions for this exact address: a complete phone number, which is normalized to E.164 first, or an opaque identifier exactly as Apple supplied it. Prefix matching is unsupported, so a partial value returns an empty page.

address_typestring

Return only suppressions whose address is of this kind.

Possible values: phone_number, opaque_user_id

reasonstring

Return only suppressions with this reason:

  • manual: Added through the API or dashboard.
  • opted_out: The customer or Apple signaled they should not be contacted.

Possible values: manual, opted_out

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.

Response Payload

data
array of object
required

Page of suppressions in force, most recent first by effective_at. Ended suppressions are left out; fetch one by ID to read it.

Show child attributes
next_cursor
nullable string
required

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

prev_cursor
nullable string
required

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

refresh_cursor
nullable string
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.

Continue with the documentation, guides and examples for this topic.