Saltar al contenido principal
POST
/
api
/
v1
/
opt-outs
Set or clear per-channel WhatsApp opt-out
curl --request POST \
  --url https://app.flowella.io/api/v1/opt-outs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "set",
  "whatsappChannelId": "<string>",
  "phone": "<string>",
  "reason": "<string>"
}
'
{
  "active": true,
  "optOutId": "<string>",
  "revokedAt": "2023-11-07T05:31:56Z"
}
Gestiona el consentimiento de WhatsApp por canal. action: set crea o reactiva una baja para el canal y número indicados. action: clear la revoca. Las llamadas clear son idempotentes y seguras.

​
Autenticación

Todas las solicitudes requieren la cabecera Authorization: Bearer <api_key> con una clave que empieza por el prefijo flo_.

​
Cuerpo de la solicitud

​
action
string
requerido
set para crear o reactivar una baja, o clear para revocarla.
​
whatsappChannelId
string
requerido
ID del canal de WhatsApp al que se aplica la baja.
​
phone
string
requerido
Número de teléfono del contacto (entre 3 y 32 caracteres).
​
reason
string
Motivo opcional de la baja (hasta 500 caracteres). Solo se usa cuando action es set.

​
Respuesta

​
optOutId
string
ID interno del registro de baja. Puede ser null si la baja se revocó.
​
active
boolean
requerido
true si la baja está activa actualmente; false si está revocada o nunca se creó.
​
revokedAt
string
Marca de tiempo ISO 8601 de cuándo se revocó la baja. null si está activa.

​
Errores

CódigoSignificado
400Error de validación del cuerpo.
401Falta la clave de API o no es válida.
404Canal no encontrado.
429Limitado por tasa.

​
Ejemplo

Dar de baja a un contacto: 
curl -X POST https://app.flowella.io/api/v1/opt-outs \
  -H "Authorization: Bearer flo_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "set",
    "whatsappChannelId": "chn_xxxxxxxxxxxx",
    "phone": "+34612345678",
    "reason": "Solicitud por correo"
  }'
Revocar una baja: 
curl -X POST https://app.flowella.io/api/v1/opt-outs \
  -H "Authorization: Bearer flo_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "clear",
    "whatsappChannelId": "chn_xxxxxxxxxxxx",
    "phone": "+34612345678"
  }'

Autorizaciones

​
Authorization
string
header
requerido

Organization API key (flo_…). Send as Authorization: Bearer <key>.

Cuerpo

application/json
​
action
enum<string>
requerido
Opciones disponibles:
set
​
whatsappChannelId
string
requerido
​
phone
string
requerido
Required string length: 3 - 32
​
reason
string
Maximum string length: 500

Respuesta

Current opt-out state

​
active
boolean
requerido
​
optOutId
string | null
​
revokedAt
string<date-time> | null