POST /2/users/:id/pinned_lists

Enables the authenticated user to pin a List.

Endpoint URL

https://api.twitter.com/2/users/:id/pinned_lists

Authentication and rate limits

Authentication methods
supported by this endpoint

OAuth 1.0a User context

Rate limit

User rate limit: 50 requests per 15-minute window

Path parameters

NameTypeDescription
id
 Required 
stringThe user ID who you are pinning a List on behalf of. It must match your own user ID or that of an authenticating user, meaning that you must pass the Access Tokens associated with the user ID when authenticating your request.


JSON body parameters

NameTypeDescription
list_id
 Required 
stringThe ID of the List that you would like the user id to pin.


Example requests

      curl -X POST "https://api.twitter.com/2/users/2244994945/pinned_lists -H "Authorization: OAuth $OAUTH_SIGNATURE" -H "Content-type: application/json" -d '{"list_id": "1441162269824405510"}' 
    

Example responses

      {
  "data": {
    "pinned": true
  }
}
    

Response fields

NameTypeDescription
pinnedbooleanIndicates whether the user pinned the specified List as a result of the request.