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.

Parameters

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

reason optional

Short label stored as the opt-out reason (default "api").

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 '{ "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());

Response

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

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