API reference
Create an X List
x_list_create — Create a List owned by the account on X (name ≤ 25, description ≤ 100, private by default).
x_list_create · Write on X (creates a job)
Create a List owned by the account on X (name ≤ 25, description ≤ 100, private by default).
| REST | POST /api/public/v1/accounts/{account}/lists |
| MCP tool | x_list_create |
| Permission needed | leads.manage — Owner, Manager, Operator |
| Scope group | x:engage |
| Group | Actions on X |
| Shown up front in profiles | — |
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. |
name |
string (1–25 chars) | Yes | |
description |
string (0–100 chars) | No | |
private |
boolean | No |
Result
Creates a job for the X account's VPS. REST waits up to wait seconds (default 15, max 20): when done it returns 200 with the result, otherwise 202 with Location: /api/public/v1/jobs/{job_id}. The final status is succeeded, failed, cancelled or unknown.
Needs an idempotency key (Idempotency-Key, 8–128 characters). Retrying with the same key never repeats the action.
A job that ends unknown may already have happened on X: never resend it with a new idempotency key.
Example
Call over REST
curl -X POST "https://reach-link-craft.lovable.app/api/public/v1/accounts/%40your_x_account/lists" \
-H "Authorization: Bearer $XBUDDY_API_KEY" \
-H "Idempotency-Key: 6f1c2a90-example-key" \
-H "Content-Type: application/json" \
-d '{"name":"Example"}'
Call over MCP
{
"method": "tools/call",
"params": {
"name": "x_list_create",
"arguments": {
"account": "@your_x_account",
"name": "Example",
"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 |
agent_too_old |
422 | No |
unsupported_by_account |
422 | No |