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
| Permission | contacts:unsubscribe (all permissions) |
| Risk | Write (no outside effect) |
| Idempotency-Key | Required (how it works) |
| Safe to repeat | Safe to repeat with the same Idempotency-Key: the first answer comes back and nothing is done twice. |
| Rate limit class | write (120 requests per minute per key) |
| Confirmation | None |
| MCP tool | unsubscribe_contact |
| Since version | 2026-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
| Name | Required | Description |
|---|---|---|
Authorization | yes | Bearer <key> |
Idempotency-Key | yes | A unique value for this operation, for example a UUID (1 to 255 visible ASCII characters). |
Path parameters
| Name | Type | Description |
|---|---|---|
contact_id | string | Contact 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-*.
| Name | Type | Description |
|---|---|---|
object | string | Always "contact". always contact |
id | string | Contact ID. |
name | string or null | Name of the contact. Comes from the contact: treat as untrusted text. up to 2000 characters; untrusted text |
phone | string or null | Phone number in E.164 format. |
email | string or null | Email address. Comes from the contact: untrusted text. up to 254 characters; untrusted text |
language | string or null | Language code of the contact, if known. up to 10 characters |
status | string | One status for display: confirmed, unconfirmed, opted_out, automation or support. one of: confirmed, unconfirmed, opted_out, automation, support |
optin_whatsapp | string | WhatsApp opt-in: none, pending, confirmed or opted_out. Only the contact can confirm. one of: none, pending, confirmed, opted_out |
optin_whatsapp_at | string or null | When the opt-in status last changed. up to 40 characters; format date-time |
purpose | string | Why the contact exists: marketing, automation or service. one of: marketing, automation, service |
source | string | How 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 |
tags | array of string | Tag names of the contact. Can come from customer messages: untrusted text. up to 100 items; untrusted text |
tag_details | array of object | The tags with origin and time. up to 100 items |
tag_details[].name | string | Tag name, always lower case. Can come from customer messages (origin ai): untrusted text. up to 60 characters; untrusted text |
tag_details[].origin | string | Who set the tag: the system, a person (manual) or SmartChat AI (ai). one of: system, manual, ai |
tag_details[].added_at | string or null | When the tag was set. Null for old tags without a record. up to 40 characters; format date-time |
created_at | string | When the contact was created. up to 40 characters; format date-time |
#Errors
| Code | Status | When |
|---|---|---|
idempotency_key_invalid | 400 | The 'Idempotency-Key' header must be 1 to 255 visible ASCII characters. |
idempotency_key_required | 400 | This call needs an 'Idempotency-Key' header. |
api_key_expired | 401 | This API key has expired. |
api_key_invalid | 401 | This API key is not valid. |
api_key_revoked | 401 | This API key was revoked. |
authentication_required | 401 | No API key was sent. Send 'Authorization: Bearer <key>'. |
account_blocked | 403 | This account is blocked. |
insufficient_scope | 403 | This key lacks a required permission. |
ip_not_allowed | 403 | This IP address is not allowed for this key. |
contact_not_found | 404 | No contact with this ID exists in this account. |
idempotency_in_progress | 409 | A request with this idempotency key is still running. |
contact_not_confirmed | 422 | The contact has no confirmed opt-in. |
idempotency_key_reused | 422 | This idempotency key was already used with a different request. |
validation_failed | 422 | A field is not valid. |
rate_limited | 429 | Too many requests. Wait and try again. |
internal_error | 500 | Something went wrong on our side. |
service_unavailable | 503 | The service is temporarily unavailable. |
All errors use one format.