固定したリストを管理する

ご注意ください: このガイドは、クイックスタート概要で示した前提条件をすでに満たしていることを前提としています。

​

ピン留め済みListを管理するリクエストを作成する手順

ステップ1：PostmanでListエンドポイントコレクションを選択

PostmanにX API v2コレクションを読み込んだら、“List”フォルダーに移動し、次に“Pinned Lists”フォルダーを選択して、“Pin a List” を選びます。  

ステップ2：ピン留めするListを指定

ピン留め済みListを管理するエンドポイントには2つのIDが必要です。1つはユーザー（Listをピン留めする認証済みユーザー）のID、もう1つは対象のList（ピン留めされるList）のIDです。ユーザーIDは認証中のユーザーIDと一致している必要があり、これはリクエストの認証時にそのユーザーIDに関連付けられたAccess Tokensを渡す必要があることを意味します。この場合は自分のユーザーに属するIDを指定できます。自分のIDは次の2つの方法で確認できます。

1. users lookup のusernameエンドポイントを使用し、usernameを渡すと、idフィールドが返ってきます。
2. 自分のAccess Tokenを見ると、数値部分が自分のユーザーIDです。

対象のList IDは有効な任意のリストで構いません。Postmanで “Params” タブに移動し、idパス変数の “Value” 列にユーザーIDを入力します。次に “Body” タブに移動し、ピン留めしたいListのIDを list_id パラメータの値として入力します。いずれのIDの前後にもスペースを入れないように注意してください。

Key	Value	Parameter type
id	ユーザーID	path
list_id	ピン留め対象のList ID	body

これで、“Send” ボタンの横に同様のURLが表示されるはずです：

      https://api.x.com/2/users/2244994945/pinned_lists

ステップ3：リクエストを送信し、レスポンスを確認する

準備が整ったら「Send」ボタンをクリックすると、以下のサンプルと同様のレスポンスが返ってきます。

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

返却されたレスポンスオブジェクトでキー pinned の値が true の場合、対象の List のピン留めは正常に完了しています。 

List のピン留めを解除するには、Postman に読み込まれた X API v2 コレクションの「Lists」フォルダーにある「Unpin List」リクエストを選択します。このエンドポイントには、認証済みユーザーの ID と、ピン留めを解除する List の ID が必要です。「Params」タブで、id 列にはユーザー ID を、list_id 列にはピン留めを解除する List の ID を入力します。 

削除リクエストが成功すると、次の例のようなレスポンスが返されます:

{
  "data": {
    "pinned": false
  }
}