List メンバーの管理

​

List メンバー管理 クイックスタート ガイド

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

​

Listメンバー管理リクエストを作成する手順

​

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

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

​

手順2: 追加するユーザーを指定する

List メンバーを管理する endpoint では 2 つの ID が必要です。List の ID と、追加するユーザーの ID です。users lookup を使用してユーザーの ID を取得でき、ユーザー名を渡すと id フィールドが返されます。

対象 ID は有効なユーザー ID であれば任意で指定できます。Postman で「Params」タブに移動し、id パス変数の「Value」列に自身の ID を入力します。次に「Body」タブに移動し、追加したいユーザーの ID を user_id パラメータの値として入力します。いずれの ID にも前後のスペースを含めないよう注意してください。

Key	Value	Parameter type
id	List の ID	path
user_id	メンバーとして追加したい対象ユーザーの ID	body

これで、「Send」ボタンの横に次のような URL が表示されるはずです:

https://api.x.com/2/lists/1441162269824405510/members

手順3: リクエストを送信し、レスポンスを確認する

すべての設定が完了したら、「Send」ボタンを押すと、次のサンプルレスポンスに類似したレスポンスが返ってきます:

{
  "data": {
    "is_member": true
  }
}

返却されたレスポンスオブジェクトでキー is_member の値が true の場合、ユーザーは List のメンバーとして正常に追加されています。 

List からメンバーを削除するには、Postman に読み込まれている X API v2 コレクションの「Lists」フォルダーにある「Remove a member」リクエストを選択します。この endpoint では、List の ID と、削除するメンバーのユーザー ID が必要です。「Params」タブで、id 列には List の ID を、user_id 列には削除対象のユーザー ID を入力します。 

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

{
  "data": {
    "is_member": false
  }
}