ピン留めしたListの管理

ご留意ください: 本ガイドは、クイックスタート概要 に記載された前提条件を済ませていることを想定しています。

​

ピン留め済みの List を管理するリクエストを構築する手順

ステップ1: Postman で List の endpoint コレクションを選択する

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

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

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

1. users lookup の username endpoint を使用して、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」リクエストを選択します。この endpoint には、認証済みユーザーのIDと、ピン留めを解除する List のIDが必要です。「Params」タブで、id 列の値としてユーザーIDを、list_id 列の値としてピン留めを解除する List のIDを入力します。 

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

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