> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Inicio rápido

> Agregue, consulte y elimine una identidad de la lista de no contactar en pocos minutos.

<Tip>
  Del **registro en la lista al primer bloqueo** en pocos pasos. La API Key necesita los alcances `suppressions:read` y `suppressions:write`.
</Tip>

## En resumen

* **Agregue** email, teléfono, Telegram o Instagram a la lista global de no contactar.
* **Consulte** entradas con filtros por tipo, motivo y búsqueda.
* **Elimine** por ID o por identidad cuando el cliente vuelva a aceptar mensajes.

Contexto: [Introducción](/es/suppressions-api/como-funciona/introducao). Alcances: [Alcances de API Key](/es/suppressions-api/como-funciona/escopos-da-api-key).

## Antes de empezar

| Ítem                               | Obligatorio                                       |
| ---------------------------------- | ------------------------------------------------- |
| Clave con **`suppressions:write`** | Sí, para agregar o eliminar                       |
| Clave con **`suppressions:read`**  | Sí, para listar y consultar                       |
| Auth                               | `Authorization: Bearer sk_live_...` o `x-api-key` |

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

***

## 1. Agregar a la lista

El teléfono bloquea **SMS, WhatsApp, RCS y voz** de una vez — como poner el número en el cuaderno de la portería.

```http theme={null}
POST /v1/suppressions
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx
```

```json theme={null}
{
  "type": "phone",
  "value": "+55 (11) 99999-0000",
  "reason": "manual",
  "note": "Cliente pidió no ser contactado"
}
```

Respuesta esperada: **201** (entrada nueva) o **200** (ya existía, idempotente). La API normaliza el teléfono a E.164 antes de guardar.

<Note>
  La inclusión es **idempotente**: si la identidad ya está activa, la API devuelve la entrada existente sin duplicar.
</Note>

### Email, Telegram o Instagram

```json theme={null}
{
  "type": "email",
  "value": "User@Example.com",
  "reason": "complaint",
  "note": "Marcó como spam"
}
```

Detalles de formato: [Normalización por tipo](/es/suppressions-api/como-funciona/normalizacao).

***

## 2. Listar y consultar

**Listar** con filtros opcionales:

```http theme={null}
GET /v1/suppressions?type=phone&limit=20&page=1
Authorization: Bearer sk_live_xxxxx
```

Parámetros útiles: `type`, `reason`, `origin`, `channel`, `search`.

**Consultar una entrada** por el ID devuelto en el POST:

```http theme={null}
GET /v1/suppressions/{id}
Authorization: Bearer sk_live_xxxxx
```

***

## 3. Eliminar de la lista

Por ID:

```http theme={null}
DELETE /v1/suppressions/{id}
Authorization: Bearer sk_live_xxxxx
```

Por identidad (sin necesitar el ID):

```http theme={null}
DELETE /v1/suppressions/by-identity
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx
```

```json theme={null}
{
  "type": "email",
  "value": "cliente@example.com"
}
```

<Warning>
  Eliminar **reactiva el envío de inmediato**. Si la dirección vuelve a generar bounce, complaint o `STOP`, puede suprimirse de nuevo automáticamente.
</Warning>

***

## 4. Importar en lote

En la API, envíe hasta **100** ítems por llamada:

```http theme={null}
POST /v1/suppressions/batch/add
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx
```

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

Cada ítem devuelve estado individual: agregada, ya existente o inválida.

En el **panel** (**Audiencia → Supresiones**), importe CSV/XLSX con cabeceras `type,value,reason` — hasta 1.000 filas, en lotes de 100. La columna `channel` en el CSV es contexto de importación en el panel; en la API v1 el bloqueo sigue el `type` (teléfono bloquea sms/whatsapp/rcs/voice).

Para eliminar en lote: `POST /v1/suppressions/batch/remove` con `ids` y/o `identities`.

***

## Próximos pasos

* [Normalización](/es/suppressions-api/como-funciona/normalizacao): cómo trata la API cada tipo
* [Eventos de webhooks](/es/suppressions-api/como-funciona/eventos-do-webhooks): sepa cuándo alguien entra o sale de la lista
* [Troubleshooting](/es/suppressions-api/como-funciona/troubleshooting): códigos comunes