Kontakt abmelden

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

Schließt den Kontakt von Kampagnen und Marketing-Sendungen aus (gleiche Wirkung wie eine STOP-Antwort). Idempotent: Einen bereits ausgeschlossenen Kontakt abzumelden liefert changed = false.

Wer den Opt-out verlangt hat: Mit requested_by = "contact" (oder ohne das Feld) ist es die Person, die keine Marketing-Nachrichten mehr möchte, also ein Widerruf der Einwilligung: Sie kann nur mit einer neuen Einwilligung zurückkommen. Mit requested_by = "business" ist es Ihre eigene Entscheidung: Der Kontakt wird ausgeschlossen, seine Einwilligung bleibt unverändert. Jeder andere Wert liefert 422.

Parameter

4 · 2 Pflichtfelder

apikey erforderlich

Ihr API Key (der Header X-API-Key funktioniert ebenfalls).

id erforderlich

Kontakt-ID (Ganzzahl, im Pfad). Verwenden Sie GET /api/contacts, um sie zu finden.

requested_by optional

Wer den Opt-out verlangt hat: contact (die Person, Widerruf der Einwilligung; der Wert, wenn das Feld fehlt) oder business (Ihre Entscheidung, die Einwilligung bleibt). Verwenden Sie contact, wenn die Person es verlangt hat.

reason optional

Grund in Ihren eigenen Worten (höchstens 191 Zeichen), im Verlauf des Kontakts gespeichert.

Brauchen Sie Hilfe bei der Integration? info@sendapp.live

Anfrage

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

Antwort

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