Update a list: POST /client/lists/update

Docs

Update a list

Change the name, description or privacy of a list you own. Fields you leave out stay as they are.

POST/client/lists/update

Your account, your proxy, your risk.

Account actions run with the session cookie of your own X account and go out through your own proxy. Use only accounts you control and follow X's rules. Automated posting, following or liking can get the account limited or suspended; that is between you and X. Treat the cookie like a password: it gives full access to the account. Trial keys cannot call these endpoints.

How to copy the cookie and which proxy to use: Your X session (cookie).

Parameters

cookiebody · string · 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.
proxybody · string · required
Your proxy, format http://user:pass@host:port. The requests to X go out through it. Used only for this request.
list_idbody · string · required
Numeric ID of the list, the number in the list URL (x.com/i/lists/<id>).
namebody · string · optional
New name, 1 to 25 characters.
descriptionbody · string · optional
New description, up to 100 characters. An empty string clears it.
privatebody · boolean · optional
true for private, false for public.

Name	In	Type	Required	Description
cookie	body	string	yes	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.
proxy	body	string	yes	Your proxy, format http://user:pass@host:port. The requests to X go out through it. Used only for this request.
list_id	body	string	yes	Numeric ID of the list, the number in the list URL (x.com/i/lists/<id>).
name	body	string	no	New name, 1 to 25 characters.
description	body	string	no	New description, up to 100 characters. An empty string clears it.
private	body	boolean	no	true for private, false for public.

Body parameters are sent as a JSON object with Content-Type: application/json.

Notes

No simple format: with format=simple the answer is the usual {status_code, response} wrapper.
The cookie and proxy fields: Your X session (cookie).

Example request

curl -X POST 'https://api.twittrapi.com/client/lists/update' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"cookie":"auth_token=...; ct0=...","proxy":"http://user:pass@host:port","list_id":"1500000000000000000","name":"API watchlist 2"}'

import httpx

resp = httpx.post(
    "https://api.twittrapi.com/client/lists/update",
    headers={"X-API-KEY": "YOUR_API_KEY"},
    json={
        "cookie": "auth_token=...; ct0=...",
        "proxy": "http://user:pass@host:port",
        "list_id": "1500000000000000000",
        "name": "API watchlist 2",
    },
    timeout=60,
)
print(resp.status_code, resp.json())

const resp = await fetch("https://api.twittrapi.com/client/lists/update", {
  method: "POST",
  headers: { "X-API-KEY": process.env.TWITTRAPI_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    cookie: "auth_token=...; ct0=...",
    proxy: "http://user:pass@host:port",
    list_id: "1500000000000000000",
    name: "API watchlist 2",
  }),
});
console.log(resp.status, await resp.json());

Base URL https://api.twittrapi.com, key in the X-API-KEY header. The SDKs do not wrap account actions, so the examples are plain HTTP calls.

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.

Example response coming soon.

In the raw format, field names and nesting come from X and can change without notice. See Response format.

Errors

400The body is not valid JSON.
422A required field is missing (including proxy), an ID is not numeric, or the cookie has no ct0. Also: the account is suspended, X rejected the session, or the text was already posted.
407The proxy is unreachable or timed out.
422None of name, description and private is set, name is empty, name is over 25 or description over 100 characters, or private is not true or false.
X'sAny status X answers with (for example 401, 403, 404): passed through with X's body.

Errors every endpoint can return (401, 402, 403, 404, 408, 409, 429, 5xx), and which of them are charged, are on the Errors page. Calls that fail with 400, 408, 409 or a 5xx error are refunded.