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.

Parametri

3 · 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.

reason opzionale

Etichetta breve salvata come motivo dell'opt-out (default "api").

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 '{ "reason": "crm_sync" }'

<?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(['reason' => 'crm_sync']),
]);
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({ reason: 'crm_sync' })
});
console.log(await res.json());

Risposta

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

{
  "status": "error",
  "message": "Contact not found."
}