Create community

10 credits per call · All plans from $0.00012/credit

curl -X POST https://xquik.com/api/v1/x/communities \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "account": "myxhandle",
    "name": "Crypto Traders Hub",
    "description": "A community for crypto traders to share insights and strategies."
  }' | jq

Headers

x-api-key

string

required

Your API key. Session cookie authentication is also supported. Generate a key from the dashboard.

Content-Type

string

required

Must be application/json.

Body

account

string

required

The connected X account to create the community as. Must be a username you have connected to your Xquik account.

name

string

required

The name for the new community.

description

string

Optional description for the community explaining its purpose.

Response

communityId

string

The unique ID of the newly created community.

communityName

string

The name of the created community. Omitted if unavailable.

success

boolean

Always true on success.

{
  "communityId": "1893726451023847424",
  "communityName": "My Community",
  "success": true
}

{ "error": "invalid_input", "message": "Missing or invalid community name or description" }

Missing account, name, or description, or the values do not meet validation requirements.

{ "error": "unauthenticated", "message": "Missing or invalid API key" }

Missing or invalid API key.

{ "error": "no_subscription", "message": "No active subscription" }

An active subscription is required to create communities. Subscribe from the dashboard.

{ "error": "insufficient_credits", "message": "Insufficient credits" }

Insufficient credits for this operation. Top up your credit balance from the dashboard.

{ "error": "account_not_found", "message": "X account not found. Connect it first at /dashboard/account?tab=x-accounts." }

The specified account is not connected to your Xquik account. Connect it from the dashboard.

{ "error": "account_needs_reauth" }

The connected X account failed a recent login attempt and needs to be reconnected. Reconnect it from the dashboard.

{ "error": "account_restricted" }

The connected X account is locked, suspended, recovering, or temporarily restricted. Resolve the restriction on X before retrying.

{ "error": "x_content_too_long", "message": "..." }

X rejected the write. Possible codes: x_content_too_long, x_duplicate_action, x_account_suspended, x_account_protected, x_target_not_found, x_account_feature_required, x_rejected. See error handling for details.

{ "error": "rate_limit_exceeded", "retryAfter": 60 }

The request hit an Xquik tier limit, or X throttled the community creation. Possible codes: rate_limit_exceeded, x_rate_limited, or x_daily_limit. Respect the Retry-After header when present.

{ "error": "x_transient_error", "message": "..." }

A transient write service issue occurred. Safe to retry with exponential backoff.

{ "error": "x_write_failed", "message": "Write failed. Try again later." }

Xquik could not complete the write and did not receive a more specific error from X. Check the account and retry later.

Related endpoints: Delete Community to remove a community, Join Community to join an existing community, Leave Community to leave a community.

Documentation Index

​Headers

​Body

​Response

Headers

Body

Response