Pin a List

POST /2/users/{id}/pinned_lists
User token O auth2 user token

Causes a user to pin a List.

Path parameters

  • id string Required

    The ID of the authenticated source user that will pin the List

Body

  • list_id string

    The unique identifier of this List.

    Format should match the following pattern: ^[0-9]{1,19}$.

Responses

  • 200

    The request was successful

    Hide response attributes Show response attributes object
    • data object
      Hide data attribute Show data attribute object
      • pinned boolean
    • errors array[object]

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

      At least 1 element.

      Hide errors attributes Show errors attributes array[object]
      • type string Required
      • title string Required
      • detail string
      • status integer
  • default

    The request has failed.

    Hide response attributes Show response attributes object
    • code integer(int32) Required
    • message string Required
POST /2/users/{id}/pinned_lists 
curl \
 -X POST https://api.twitter.com/2/users/2244994945/pinned_lists \
 -H "Authorization: Oauth $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"list_id":"1146654567674912769"}'
Request example 
{
  "list_id": "1146654567674912769"
}
Request examples 
{
  "list_id": "1146654567674912769"
}
Response examples (200) 
{
  "data": {
    "pinned": true
  },
  "errors": [
    {
      "type": "string",
      "title": "string",
      "detail": "string",
      "status": 42
    }
  ]
}
Response examples (200) 
{
  "data": {
    "pinned": true
  },
  "errors": [
    {
      "type": "string",
      "title": "string",
      "detail": "string",
      "status": 42
    }
  ]
}
Response examples (default) 
{
  "code": 42,
  "message": "string"
}
Response examples (default) 
{
  "code": 42,
  "message": "string"
}