Saltar al contenido

Bajas y bloqueos

Direcciones a las que no se envía.

Listar direcciones bloqueadas

GET/v1/suppressions

Scope necesario: read o full. Una clave full incluye send y read.

Direcciones activas de la organización (las caducadas no salen), de la más reciente a la más antigua. email busca una dirección exacta. Paginación por cursor.

Respuestas

  • 200
    { data: [Suppression], nextCursor }.

Ejemplo

bash
curl "https://api.vemudo.com/v1/[email protected]" -H "Authorization: Bearer $VEMUDO_API_KEY"

Añadir una dirección a bajas y bloqueos

POST/v1/suppressions

Scope necesario: full. Una clave full incluye send y read.

Responde 201 si la añade (o reemplaza un bloqueo temporal o caducado) y 200 con la fila sin cambios si ya estaba bloqueada. reason: unsubscribe (por defecto con clave live) o manual (único valor admitido y valor por defecto con clave test: 403 live_key_required si se pide unsubscribe). Límite de 1000 altas por hora y organización (429 rate_limited).

Cuerpo application/json

CampoDescripción
emailstring · obligatoriolongitud 0–254 · ej.: [email protected]
reasonstring unsubscribe (baja pedida por el destinatario) o manual.valores: manual | unsubscribe · por defecto: unsubscribe
noteobject | null Nota interna, hasta 200 caracteres, sin saltos de línea.longitud 0–200

Respuestas

  • 200
    Suppression (201 si es nueva, 200 si ya existía y no cambia).

Ejemplo

bash
curl -X POST https://api.vemudo.com/v1/suppressions -H "Authorization: Bearer $VEMUDO_API_KEY" -H "Content-Type: application/json" -d '{"email":"[email protected]","reason":"unsubscribe"}'

Quitar una dirección de bajas y bloqueos

DELETE/v1/suppressions/{id}

Scope necesario: full. Una clave full incluye send y read.

Solo con clave live (403 live_key_required). Las bajas (unsubscribe) y las quejas (complaint) no se pueden quitar por API (403 suppression_removal_forbidden): se hace desde el panel. Responde 204.

Parámetros

CampoDescripción
idstring · ruta · obligatorio

Respuestas

  • 200
    Sin contenido.

Ejemplo

bash
curl -X DELETE https://api.vemudo.com/v1/suppressions/$ID \
  -H "Authorization: Bearer $VEMUDO_API_KEY"