Update profile

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

curl -X PATCH https://xquik.com/api/v1/x/profile \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "account": "myxaccount",
    "name": "New Display Name",
    "description": "Building cool things",
    "location": "San Francisco",
    "url": "https://example.com"
  }' | 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

X username or account ID of your connected account to act as.

name

string

Display name. Maximum 50 characters.

description

string

Profile bio. Maximum 160 characters.

location

string

Profile location. Maximum 30 characters.

url

string

Website URL. Must be a valid URL.

Response

success

boolean

Always true on success.

{
  "success": true
}

{ "error": "invalid_input", "message": "Invalid field value or length exceeded" }

One or more fields exceed their maximum length or the URL is invalid.

{ "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. 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_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": "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": "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 profile update. 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": "Failed to complete the action" }

The write action failed. Retry after a short delay.

Related: Update Avatar and Update Banner to change profile images.

Documentation Index

​Headers

​Body

​Response

Headers

Body

Response