Cancelar subscrição do contacto

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

Exclui o contacto das campanhas e dos envios de marketing (mesmo efeito de uma resposta STOP). Idempotente: cancelar um contacto já excluído devolve changed = false.

Quem pediu o opt-out: com requested_by = "contact" (ou sem o campo) é a pessoa que já não quer mensagens de marketing, ou seja, uma revogação do consentimento: só poderá voltar com um novo consentimento. Com requested_by = "business" é uma decisão sua: o contacto é excluído mas o consentimento fica como está. Qualquer outro valor devolve 422.

Parâmetros

4 · 2 obrigatórios

apikey obrigatório

A sua API Key (o cabeçalho X-API-Key também funciona).

id obrigatório

ID do contacto (inteiro, no path). Use GET /api/contacts para o encontrar.

requested_by opcional

Quem pediu o opt-out: contact (a pessoa, revogação do consentimento; é o valor se faltar) ou business (decisão sua, o consentimento mantém-se). Use contact quando é a pessoa a pedir.

reason opcional

Motivo com as suas palavras (máximo 191 caracteres), guardado no histórico do contacto.

Precisa de ajuda com a integração? info@sendapp.live

Pedido

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());

Resposta

{
  "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)."
}