Désinscrire un contact

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

Exclut le contact des campagnes et des envois marketing (même effet qu'une réponse STOP). Idempotent : désinscrire un contact déjà exclu renvoie changed = false.

Qui a demandé l'opt-out : avec requested_by = "contact" (ou sans le champ), c'est la personne qui ne veut plus de messages marketing, donc un retrait du consentement : elle ne pourra revenir qu'avec un nouveau consentement. Avec requested_by = "business", c'est votre décision : le contact est exclu mais son consentement reste inchangé. Toute autre valeur renvoie 422.

Paramètres

4 · 2 obligatoires

apikey obligatoire

Votre API Key (l'en-tête X-API-Key fonctionne aussi).

id obligatoire

ID du contact (entier, dans le chemin). Utilisez GET /api/contacts pour le trouver.

requested_by facultatif

Qui a demandé l'opt-out : contact (la personne, retrait du consentement ; c'est la valeur si le champ manque) ou business (votre décision, le consentement reste). Utilisez contact quand c'est la personne qui le demande.

reason facultatif

Motif avec vos mots (191 caractères au maximum), enregistré dans l'historique du contact.

Besoin d'aide pour l'intégration ? info@sendapp.live

Requête

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

Réponse

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