suppression

List suppression entries

List do-not-contact entries (opt-outs), newest first, with cursor pagination.

Suppressed identifiers are excluded from every send automatically, single sends and campaigns alike.

A STOP reply, on WhatsApp as well as SMS, suppresses the sender on every channel and every topic, with reason stop_keyword. A permanent email bounce (or one the provider does not classify) and a spam complaint suppress the address; a transient bounce does not.

This list works by identifier and before a contact exists; a contact's own suppressed flag (PATCH /api/v1/contacts/{id}) blocks every send to that contact too. Either one stops a send.

Filters: channel=, topic=, business_id= (must belong to the workspace), and identifier=. Phone lookups match any South African format (+27…, 27…, 0…, or 9 digits); a number from another country needs its leading + (anything unreadable returns 400); emails match case-insensitively.

added_by is the user id for manual dashboard adds, null for system-captured opt-outs (STOP, unsubscribe, API).

Page with ?limit= (default 100, max 500) and ?cursor= (the previous page's next_cursor).

get/api/v1/suppression

Request

Base URL: https://app.blueticked.com
URL: https://app.blueticked.com/api/v1/suppression
Auth: HTTP bearer

Query parameters

channelstring

Filter by channel.

limitinteger

Maximum number of items to return.

cursorstring

Opaque pagination cursor. Pass the next_cursor from a previous response; do not construct it yourself.

Response

Success

next_cursorstring nullable required

has_moreboolean required

request_idstring required

Example response

{
  "data": [
    {
      "id": "b57fc118-fd61-4387-9bd3-3b019b2b0d3e",
      "identifier": "+27800000001",
      "reason": "stop_keyword",
      "created_at": "2026-06-12T08:00:00.000Z"
    }
  ],
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.