Opt out contact

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

Exclude the contact from campaigns and marketing sends (same effect as a STOP reply). Idempotent: opting out a contact that is already excluded returns changed = false.

Who asked for the opt-out: with requested_by = "contact" (or without the field) it is the person who no longer wants marketing messages, so a withdrawal of consent: they can only come back with a new consent. With requested_by = "business" it is your own decision: the contact is excluded but their consent stays as it is. Any other value returns 422.

Parameters

4 · 2 required

apikey required

Your API Key (the X-API-Key header also works).

id required

Contact ID (integer, in the path). Use GET /api/contacts to find it.

requested_by optional

Who asked for the opt-out: contact (the person, a withdrawal of consent; the value when missing) or business (your decision, the consent stays). Use contact when the person asked.

reason optional

Reason in your own words (up to 191 characters), saved in the contact's history.

Need help with the integration? info@sendapp.live

Request

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

Response

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