Skip to content
X-Buddy
Tiếng Việt

API reference

Add to do-not-contact

suppression_add — Never reach this person again from any account: waiting jobs aimed at them are cancelled at once.

Markdown version

suppression_add · Changes an X-Buddy setting

Never reach this person again from any account: waiting jobs aimed at them are cancelled at once.
REST POST /api/public/v1/suppressions
MCP tool suppression_add
Permission needed leads.manage — Owner, Manager, Operator
Scope group audience:write
Group Contacts and lists
Shown up front in profiles Contacts & lists

Input

Field Type Required Description
person string (1–60 chars) Yes Person on X: @handle (or handle) or numeric user id prefixed with #, e.g. #44196397
note string (0–500 chars) No

Result

Returns the operation's result in the { data, meta } envelope.

Needs an idempotency key (Idempotency-Key, 8–128 characters). Retrying with the same key never repeats the action.

Example

Call over REST

curl -X POST "https://reach-link-craft.lovable.app/api/public/v1/suppressions" \
  -H "Authorization: Bearer $XBUDDY_API_KEY" \
  -H "Idempotency-Key: 6f1c2a90-example-key" \
  -H "Content-Type: application/json" \
  -d '{"person":"@example_person"}'

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "suppression_add",
    "arguments": {
      "person": "@example_person",
      "idempotency_key": "6f1c2a90-example-key"
    }
  }
}

Errors you may get

Code HTTP Retryable
unauthorized 401 No
key_expired 401 No
integration_revoked 401 No
connection_not_linked 403 No
integration_paused 403 No
workspace_integrations_paused 403 No
integration_authorization_lost 403 No
workspace_suspended 403 No
forbidden 403 No
invalid_input 422 No
rate_limited 429 Yes
internal 500 Yes
read_only 403 No
idempotency_key_required 428 No
idempotency_conflict 409 No
idempotency_processing 409 Yes
conflict 409 No
precondition_failed 422 No

Back to all operations