POST /2/users/:id/pinned_lists

Enables the authenticated user to pin a List.

Endpoint URL

Authentication and rate limits

Authentication methods
supported by this endpoint

OAuth 2.0 Authorization Code with PKCE

Rate limit

User rate limit (OAuth 2.0 user Access Token): 50 requests per 15-minute window per each authenticated user

OAuth 2.0 scopes required by this endpoint


Learn more about OAuth 2.0 Authorization Code with PKCE

Path parameters

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

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

Example requests

      curl -X POST " -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-type: application/json" -d '{"list_id": "1441162269824405510"}' 

Example responses

  "data": {
    "pinned": true

Response fields

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