Quick Start

From list entry to first block in a few steps. The API Key needs scopes suppressions:read and suppressions:write.

In brief

Add email, phone, Telegram, or Instagram to the global do-not-contact list.
Query entries with filters by type, reason, and search.
Remove by ID or by identity when the customer agrees to receive messages again.

Context: Introduction. Scopes: API Key scopes.

Before you start

Item	Required
Key with `suppressions:write`	Yes, to add or remove
Key with `suppressions:read`	Yes, to list and query
Auth	`Authorization: Bearer sk_live_...` or `x-api-key`

Base URL: https://api.notifique.dev.

1. Add to the list

A phone number blocks SMS, WhatsApp, RCS, and voice at once — like putting the number in the front-desk notebook.

POST /v1/suppressions
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "type": "phone",
  "value": "+55 (11) 99999-0000",
  "reason": "manual",
  "note": "Customer asked not to be contacted"
}

Expected response: 201 (new entry) or 200 (already existed, idempotent). The API normalizes the phone to E.164 before saving.

The addition is idempotent: if the identity is already active, the API returns the existing entry without duplicating.

Email, Telegram, or Instagram

{
  "type": "email",
  "value": "User@Example.com",
  "reason": "complaint",
  "note": "Marked as spam"
}

Formatting details: Normalization by type.

2. List and query

List with optional filters:

GET /v1/suppressions?type=phone&limit=20&page=1
Authorization: Bearer sk_live_xxxxx

Useful parameters: type, reason, origin, channel, search. Query a single entry by ID returned from POST:

GET /v1/suppressions/{id}
Authorization: Bearer sk_live_xxxxx

3. Remove from the list

By ID:

DELETE /v1/suppressions/{id}
Authorization: Bearer sk_live_xxxxx

By identity (no ID needed):

DELETE /v1/suppressions/by-identity
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "type": "email",
  "value": "cliente@example.com"
}

Removal re-enables sending immediately. If the address generates bounce, complaint, or STOP again, it may be suppressed again automatically.

4. Batch import

In the API, send up to 100 items per call:

POST /v1/suppressions/batch/add
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "entries": [
    { "type": "phone", "value": "5511999990000", "reason": "manual" },
    { "type": "email", "value": "bounce@example.com", "reason": "bounce" }
  ]
}

Each item returns an individual status: added, already exists, or invalid. In the dashboard (Audience → Suppressions), import CSV/XLSX with headers type,value,reason — up to 1,000 rows, in batches of 100. The channel column in the CSV is import context in the dashboard; on API v1 blocking follows type (phone blocks sms/whatsapp/rcs/voice). To remove in batch: POST /v1/suppressions/batch/remove with ids and/or identities.

Next steps

Normalization: how the API handles each type
Webhook events: know when someone enters or leaves the list
Troubleshooting: common codes

API E-mail

E-mail

Domínios

E-mails recebidos

In brief

Before you start

1. Add to the list

Email, Telegram, or Instagram

2. List and query

3. Remove from the list

4. Batch import

Next steps

​In brief

​Before you start

​1. Add to the list

​Email, Telegram, or Instagram

​2. List and query

​3. Remove from the list

​4. Batch import

​Next steps

In brief

Before you start

1. Add to the list

Email, Telegram, or Instagram

2. List and query

3. Remove from the list

4. Batch import

Next steps