Account actions

Update your profile

Change the name, bio, location, website or birth date of your account. Fields you leave out stay as they are.

Runs the same request as the Edit profile dialog on x.com. Send at least one of the profile fields; an empty string clears description, location or url.

On a verified (Premium) account, x.com warns that changing the name can remove the checkmark until X has reviewed the change.

Reference: https://www.twittrapi.com/docs/account-actions/client-profile

post/client/profile

Request

  • Base URL: https://api.twittrapi.com
  • URL: https://api.twittrapi.com/client/profile
  • Auth: API key in header X-API-KEY

Query parameters

format'raw' | 'simple'

raw (default): X's JSON passed through. simple: flat camelCase JSON with a fixed schema and a {data, nextCursor, previousCursor, hasNextPage} envelope. Same price. The header X-Response-Format: simple does the same.

Request body

cookiestring required

Cookie header of your own logged-in X session: auth_token=...; ct0=... (guest_id is used when present). How to copy it: /docs/x-session.

proxystring required

Your proxy, format http://user:pass@host:port. The requests to X go out through it. Used only for this request.

namestring

Display name, up to 50 characters. Cannot be empty.

descriptionstring

Bio, up to 160 characters.

locationstring

Location, up to 30 characters.

urlstring

Website, up to 100 characters.

birthdatestring

{day, month, year, visibility?, year_visibility?}. visibility and year_visibility are public, followers, following, mutualfollow or self; left out, X keeps the current setting. The date must be real, not in the future and at most 120 years back. null removes the birth date.

Response

Wrapper built by the API: {"status_code": <X status>, "response": "<X response body as a string>"}. The HTTP status is X's status when X answered 4xx or 5xx, otherwise 200. Parse response a second time to get X's JSON. On success response is your updated user object (X's v1.1 user: name, description, location, url, profile_image_url_https, ...).

With format=simple: {data: User}: your profile after the change, the same User object as the read endpoints. When X reports an error inside the wrapper (for example a tweet that is already liked), the usual wrapper is returned unchanged.

RawPassthrough required

X's own JSON (raw format, the default), passed through unchanged. The shape is X's and can change; see https://www.twittrapi.com/docs/response-format.

Changes

No recorded changes to this operation across all 1 revision of this API.