Opt-out contatto

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

Esclude il contatto dalle campagne e dagli invii marketing (stesso effetto di una risposta STOP). Idempotente: l'opt-out di un contatto già escluso restituisce changed = false.

Chi ha chiesto l'opt-out: con requested_by = "contact" (o senza il campo) è la persona che non vuole più messaggi di marketing, quindi una revoca del consenso: potrà tornare solo con un nuovo consenso. Con requested_by = "business" è una tua decisione: il contatto viene escluso ma il suo consenso resta com'è. Un valore diverso restituisce 422.

Parametri

4 · 2 obbligatori

apikey obbligatorio

La tua API Key (anche header X-API-Key).

id obbligatorio

ID del contatto (intero, nel path). Usa GET /api/contacts per trovarlo.

requested_by opzionale

Chi ha chiesto l'opt-out: contact (la persona, revoca del consenso; è il valore se manca) oppure business (tua decisione, il consenso resta). Usa contact quando è la persona a chiederlo.

reason opzionale

Motivo con parole tue (massimo 191 caratteri), salvato nella cronologia del contatto.

Serve aiuto con l'integrazione? info@sendapp.live

Richiesta

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

Risposta

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