smartchat

Tag contacts

Adds tags to up to 100 contacts and removes tags from them; removing a tag never deletes the contact. System tags cannot be set or removed. Needs an Idempotency-Key header; returns one result per distinct contact ID, and one failed contact does not stop the others.

POST /v1/contacts/tags

Permissioncontacts:write (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 classbulk (120 requests per minute per key)
ConfirmationNone
MCP tooltag_contacts
Since version2026-10-25

#What it does

  • Changes data in your account. It does not send messages to contacts.
  • Removes data. Only allowed for the few removals that keys may do (remove a tag, unsubscribe a webhook endpoint).
  • May start automations of the account, and an automation may send messages. The call itself sends nothing.
  • 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).

Body (JSON)

NameTypeRequiredDescription
contact_idsarray of stringyesThe contacts to change (1 to 100). up to 100 items
add_tagsarray of stringnoTags to add. Case does not matter; stored in lower case. up to 20 items
remove_tagsarray of stringnoTags to remove. A tag must not be in both add_tags and remove_tags. up to 20 items

#Examples

curl -X POST "https://api.smartchat.marketing/v1/contacts/tags" \
  -H "Authorization: Bearer $SMARTCHAT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "contact_ids": [
    "con_0f8c1a2e4b7d4c3e9a5b6d7e8f901234"
  ],
  "add_tags": [
    "vip"
  ],
  "remove_tags": [
    "lead"
  ]
}'
import os
import uuid
import requests

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

Response (200):

{
  "object": "contact_tags_update",
  "updated": 1,
  "unchanged": 0,
  "not_found": 0,
  "failed": 0,
  "results": [
    {
      "contact_id": "con_0f8c1a2e4b7d4c3e9a5b6d7e8f901234",
      "status": "updated",
      "tags": [
        "vip"
      ],
      "error_code": null
    }
  ]
}

#Response

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

NameTypeDescription
objectstringAlways "contact_tags_update". always contact_tags_update
updatedintegerContacts whose tags changed. 0 to 100
unchangedintegerContacts that already had the requested state. 0 to 100
not_foundintegerIDs that belong to no contact of this account. 0 to 100
failedintegerContacts that could not be changed, for example because they would exceed 30 tags. See error_code in results. 0 to 100
resultsarray of objectOne entry per distinct contact ID, in the order of first appearance. A repeated ID is handled once. up to 100 items
results[].contact_idstringContact ID. up to 36 characters
results[].statusstringupdated, unchanged, not_found or failed. Earlier contacts of the same call stay changed. one of: updated, unchanged, not_found, failed
results[].tagsarray of stringTags of the contact after the change. Empty if not found. Untrusted text. up to 100 items; untrusted text
results[].error_codestring or nullError code (see the error list) when status is failed, otherwise null. up to 60 characters

#Errors

CodeStatusWhen
bad_request400The request could not be read.
idempotency_key_invalid400The 'Idempotency-Key' header must be 1 to 255 visible ASCII characters.
idempotency_key_required400This call needs an 'Idempotency-Key' header.
missing_parameter400A required field is missing.
unknown_parameter400A field is not known.
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.
idempotency_in_progress409A request with this idempotency key is still running.
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.