Skip to main content
PUT
/
2
/
lists
/
{id}
Update List
curl --request PUT \
  --url https://api.x.com/2/lists/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "name": "<string>",
  "private": true
}
'
{
  "data": {
    "updated": true
  },
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.x.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string
required

The ID of the List to modify. The unique identifier of this List.

Pattern: ^[0-9]{1,19}$
Example:

"1146654567674912769"

Body

application/json
​
description
string
Maximum string length: 100
​
name
string
Required string length: 1 - 25
​
private
boolean

Response

The request has succeeded.

​
data
object
​
errors
object[]
Minimum array length: 1

An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).