PUT /2/lists/:id

Enables the authenticated user to update the meta data of a specified List that they own.

Endpoint URL

https://api.twitter.com/2/lists/:id

Authentication and rate limits

Authentication methods
supported by this endpoint

OAuth 1.0a User context

Rate limit

User rate limit: 300 requests per 15-minute window

Path parameters

NameTypeDescription
id
 Required 
stringThe ID of the List to be updated.


JSON body parameters

NameTypeDescription
description
 Optional 
stringUpdates the description of the List.
name
 Optional 
stringUpdates the name of the List.
private
 Optional 
stringDetermines whether the List should be private.


Example requests

      curl -X PUT https://api.twitter.com/2/lists/1441163524802158595 -H "Authorization: OAuth $OAUTH_SIGNATURE" -H "Content-type: application/json" -d '{"name": "test v2 update list"}'
    

Example responses

      {
  "data": {
    "updated": true
  }
}
    

Response fields

NameTypeDescription
updatedbooleanIndicates whether the List specified in the request has been updated.
Was this document helpful?
Thank you

Thank you for the feedback. We’re really glad we could help!

Thank you for the feedback. How could we improve this document?
Thank you for the feedback. Your comments will help us improve our documents in the future.