Dar de baja al contacto

POST https://app.sendapp.ai/api/contacts/{id}/opt-out

Excluye al contacto de las campañas y de los envíos de marketing (mismo efecto que una respuesta STOP). Idempotente: dar de baja a un contacto ya excluido devuelve changed = false.

Quién pidió la baja: con requested_by = "contact" (o sin el campo) es la persona que ya no quiere mensajes de marketing, es decir, una revocación del consentimiento: solo podrá volver con un nuevo consentimiento. Con requested_by = "business" es una decisión tuya: el contacto queda excluido pero su consentimiento sigue igual. Cualquier otro valor devuelve 422.

Parámetros

4 · 2 obligatorios

apikey obligatorio

Tu API Key (también sirve la cabecera X-API-Key).

id obligatorio

ID del contacto (entero, en la ruta). Usa GET /api/contacts para encontrarlo.

requested_by opcional

Quién pidió la baja: contact (la persona, revocación del consentimiento; es el valor si falta) o business (decisión tuya, el consentimiento se mantiene). Usa contact cuando lo pide la persona.

reason opcional

Motivo con tus palabras (máximo 191 caracteres), guardado en el historial del contacto.

¿Necesitas ayuda con la integración? info@sendapp.live

Solicitud

curl -X POST 'https://app.sendapp.ai/api/contacts/42/opt-out' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "requested_by": "contact", "reason": "Ha risposto alla newsletter chiedendo di non ricevere più promozioni" }'

<?php
$ch = curl_init('https://app.sendapp.ai/api/contacts/42/opt-out');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ['X-API-Key: YOUR_API_KEY', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['requested_by' => 'contact', 'reason' => 'Ha risposto alla newsletter chiedendo di non ricevere più promozioni']),
]);
echo curl_exec($ch);
curl_close($ch);

const res = await fetch('https://app.sendapp.ai/api/contacts/42/opt-out', {
  method: 'POST',
  headers: { 'X-API-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ requested_by: 'contact', reason: 'Ha risposto alla newsletter chiedendo di non ricevere più promozioni' })
});
console.log(await res.json());

Respuesta

{
  "status": "success",
  "changed": true,
  "contact": { "id": 42, "opted_out": true, "opted_out_reason": "api_contact", "...": "..." }
}

{
  "status": "error",
  "message": "requested_by must be \"contact\" (the person asked to stop receiving marketing: a withdrawal of consent) or \"business\" (your own decision: an exclusion, consent unchanged)."
}