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

API reference

Pause / resume an account

account_set_paused — Pause an X account (nothing runs on it, jobs wait) or resume it.

Markdown version

account_set_paused · Changes an X-Buddy setting

Pause an X account (nothing runs on it, jobs wait) or resume it. Does not clear a safety stop X caused.
REST POST /api/public/v1/accounts/{account}/paused
MCP tool account_set_paused
Permission needed accounts.run — Owner, Manager, Operator
Scope group x:engage
Group VPS, proxies and alerts
Shown up front in profiles Operate X accounts, Infrastructure

Input

Field Type Required Description
account string (1–100 chars) Yes The X account to use: its X-Buddy account_id (from account_list) or its @handle. Ambiguous names return candidates instead of guessing.
paused boolean Yes

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/accounts/%40your_x_account/paused" \
  -H "Authorization: Bearer $XBUDDY_API_KEY" \
  -H "Idempotency-Key: 6f1c2a90-example-key" \
  -H "Content-Type: application/json" \
  -d '{"paused":false}'

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "account_set_paused",
    "arguments": {
      "account": "@your_x_account",
      "paused": false,
      "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
ambiguous_account 409 No
account_not_allowed 403 No
not_found 404 No

Back to all operations