smartchat

Unsubscribe contact

Unsubscribes a contact with a confirmed opt-in from all marketing messages and sends no message. It cannot be undone through the API; only the contact can sign up again. Needs an Idempotency-Key header and returns the contact.

POST /v1/contacts/{contact_id}/unsubscribe

Permissioncontacts:unsubscribe (all permissions)
RiskWrite (no outside effect)
Idempotency-KeyRequired (how it works)
Safe to repeatSafe to repeat with the same Idempotency-Key: the first answer comes back and nothing is done twice.
Rate limit classwrite (120 requests per minute per key)
ConfirmationNone
MCP toolunsubscribe_contact
Since version2026-10-25

#What it does

  • Changes data in your account. It does not send messages to contacts.
  • Overwrites existing data.
  • Safe to repeat with the same Idempotency-Key.

#Request

Header

NameRequiredDescription
AuthorizationyesBearer <key>
Idempotency-KeyyesA unique value for this operation, for example a UUID (1 to 255 visible ASCII characters).

Path parameters

NameTypeDescription
contact_idstringContact ID.

#Examples

curl -X POST "https://api.smartchat.marketing/v1/contacts/con_0f8c1a2e4b7d4c3e9a5b6d7e8f901234/unsubscribe" \
  -H "Authorization: Bearer $SMARTCHAT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
import os
import uuid
import requests

response = requests.post(
    "https://api.smartchat.marketing/v1/contacts/con_0f8c1a2e4b7d4c3e9a5b6d7e8f901234/unsubscribe",
    headers={
        "Authorization": "Bearer " + os.environ["SMARTCHAT_API_KEY"],
        "Idempotency-Key": str(uuid.uuid4()),
    },
)
response.raise_for_status()
print(response.json())
const response = await fetch("https://api.smartchat.marketing/v1/contacts/con_0f8c1a2e4b7d4c3e9a5b6d7e8f901234/unsubscribe", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SMARTCHAT_API_KEY}`,
    "Idempotency-Key": crypto.randomUUID(),
  },
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

Response (200):

{
  "object": "contact",
  "id": "con_0f8c1a2e4b7d4c3e9a5b6d7e8f901234",
  "name": "Mia Muster",
  "phone": "+4915112345678",
  "email": "mia@example.com",
  "language": "en",
  "status": "opted_out",
  "optin_whatsapp": "opted_out",
  "optin_whatsapp_at": "2026-10-25T09:41:07Z",
  "purpose": "marketing",
  "source": "api",
  "tags": [
    "regular customer"
  ],
  "tag_details": [
    {
      "name": "regular customer",
      "origin": "manual",
      "added_at": "2026-10-25T09:41:07Z"
    }
  ],
  "created_at": "2026-10-25T09:41:07Z"
}

#Response

Status 200. Every response has the headers Request-Id, SmartChat-Version and X-RateLimit-*.

NameTypeDescription
objectstringAlways "contact". always contact
idstringContact ID.
namestring or nullName of the contact. Comes from the contact: treat as untrusted text. up to 2000 characters; untrusted text
phonestring or nullPhone number in E.164 format.
emailstring or nullEmail address. Comes from the contact: untrusted text. up to 254 characters; untrusted text
languagestring or nullLanguage code of the contact, if known. up to 10 characters
statusstringOne status for display: confirmed, unconfirmed, opted_out, automation or support. one of: confirmed, unconfirmed, opted_out, automation, support
optin_whatsappstringWhatsApp opt-in: none, pending, confirmed or opted_out. Only the contact can confirm. one of: none, pending, confirmed, opted_out
optin_whatsapp_atstring or nullWhen the opt-in status last changed. up to 40 characters; format date-time
purposestringWhy the contact exists: marketing, automation or service. one of: marketing, automation, service
sourcestringHow the contact came in, for example api, manual, import or landing page. Open list. Can contain outside text: untrusted. up to 40 characters; untrusted text
tagsarray of stringTag names of the contact. Can come from customer messages: untrusted text. up to 100 items; untrusted text
tag_detailsarray of objectThe tags with origin and time. up to 100 items
tag_details[].namestringTag name, always lower case. Can come from customer messages (origin ai): untrusted text. up to 60 characters; untrusted text
tag_details[].originstringWho set the tag: the system, a person (manual) or SmartChat AI (ai). one of: system, manual, ai
tag_details[].added_atstring or nullWhen the tag was set. Null for old tags without a record. up to 40 characters; format date-time
created_atstringWhen the contact was created. up to 40 characters; format date-time

#Errors

CodeStatusWhen
idempotency_key_invalid400The 'Idempotency-Key' header must be 1 to 255 visible ASCII characters.
idempotency_key_required400This call needs an 'Idempotency-Key' header.
api_key_expired401This API key has expired.
api_key_invalid401This API key is not valid.
api_key_revoked401This API key was revoked.
authentication_required401No API key was sent. Send 'Authorization: Bearer <key>'.
account_blocked403This account is blocked.
insufficient_scope403This key lacks a required permission.
ip_not_allowed403This IP address is not allowed for this key.
contact_not_found404No contact with this ID exists in this account.
idempotency_in_progress409A request with this idempotency key is still running.
contact_not_confirmed422The contact has no confirmed opt-in.
idempotency_key_reused422This idempotency key was already used with a different request.
validation_failed422A field is not valid.
rate_limited429Too many requests. Wait and try again.
internal_error500Something went wrong on our side.
service_unavailable503The service is temporarily unavailable.

All errors use one format.