リストメンバーシップ（静的リスト）
リストメンバーシップ APIは、静的リストメンバーを操作するためのリードデータベースエンドポイントを提供します。 これらのエンドポイントを使用すると、リストにリードを追加したり、リストからリードを削除したり、リストのメンバーを取得したり、1つ以上のリードがリストのメンバーであるかどうかを判断したりできます。
エンドポイント
/rest/v1/lists/{listId}/leads.json/rest/v1/lists/{listId}/leads.json/rest/v1/lists/{listId}/leads.json/rest/v1/lists/{listId}/leads/ismember.jsonリストに追加
リストに追加 リストに追加 エンドポイントは、1人以上のメンバーをリストに追加するために使用されます。 エンドポイントは、必須の listId パスパラメーターと、リード ID を含む 1 つ以上の id クエリパラメーター（最大許容値は 300）を受け取ります。
応答には、リクエストで指定した各リード ID のステータスを含む JSON オブジェクトで構成された result 配列が含まれます。
POST /rest/v1/lists/{listId}/leads.json?id=318594&id=318595
{
"requestId": "6860#1706170ba29",
"result": [
{
"id": 318594,
"status": "added"
},
{
"id": 318595,
"status": "skipped",
"reasons": [
{
"code": "1004",
"message": "Lead not found"
}
]
}
],
"success": true
}
リストから削除
リストから削除 リストから削除 エンドポイントは、リストから1人以上のメンバーを削除するために使用されます。 エンドポイントは、必須の listId パスパラメーターと、リード ID を含む 1 つ以上の id クエリパラメーター（最大許容値は 300）を受け取ります。
応答には、リクエストで指定した各リード ID のステータスを含む JSON オブジェクトで構成された result 配列が含まれます。
DELETE /rest/v1/lists/{listId}/leads.json?id=318603&id=318595&id=999999
{
"requestId": "9e79#17061689ac3",
"result": [
{
"id": 318603,
"status": "removed"
},
{
"id": 318595,
"status": "removed"
},
{
"id": 999999,
"status": "skipped",
"reasons": [
{
"code": "1004",
"message": "Lead not found"
}
]
}
],
"success": true
}
リスト ID によるリードを取得
リスト ID によるリードを取得エンドポイントは、リストのメンバーを取得するのに使用されます。 エンドポイントは、必須の listId パスパラメーターを受け取り、フィルタリング条件を指定するのにオプションで複数のクエリパラメーターを許可します。
batchSize パラメーターは、1回の呼び出しで返されるリード レコードの数を指定するために使用されます。 デフォルトと最大値は300です。
nextPageToken パラメーターは、大きな結果セットをページ分割するのに使用されます。 このパラメーターは、最初の呼び出しでは渡されませんが、ページネーションの後続の呼び出しでのみ渡されます。
fields パラメーターには、応答で返されるフィールド名のコンマ区切りのリストが含まれます。 fields パラメーターがこのリクエストに含まれていない場合、次のデフォルトフィールドが返されます：email、updatedAt、createdAt、lastName、firstName、およびid。
応答には、リクエストで指定したリードフィールドを含む JSON オブジェクトで構成された result 配列が含まれます。
GET /rest/v1/lists/{listId}/leads.json?batchSize=3
{
"requestId": "ddae#170615ba0cc",
"result": [
{
"id": 318594,
"firstName": "Hanna",
"lastName": "Crawford",
"email": "208161Robert.L.Deacon@pookmail.com",
"updatedAt": "2015-04-06T17:13:50Z",
"createdAt": "2015-04-06T17:13:50Z"
},
{
"id": 318595,
"firstName": "Bertha",
"lastName": "Fulton",
"email": "208160Tyrone.V.Dyer@trashymail.com",
"updatedAt": "2015-04-06T17:13:50Z",
"createdAt": "2015-04-06T17:13:50Z"
},
{
"id": 318596,
"firstName": "Faith",
"lastName": "England",
"email": "208159Rex.M.Bailey@dodgit.com",
"updatedAt": "2015-04-06T17:13:50Z",
"createdAt": "2015-04-06T17:13:50Z"
}
],
"success": true,
"nextPageToken": "PS5VL5WD4UOWGOUCJR6VY7JQO24LC2U5DRBU4WO4RQMPHDHTK2T3BEZOR75VLQXYB3245WW2GMDSK==="
}
リストのメンバー
リストのメンバーエンドポイントは、1 つ以上のリードがリストのメンバーであるかどうかを確認するのに使用されます。 エンドポイントは、必須の listId パスパラメーターと、リード ID を含む 1 つ以上の id クエリパラメーター（最大許容値は 300）を受け取ります。
応答には、リクエストで指定した各リード ID のステータスを含む JSON オブジェクトで構成された result 配列が含まれます。
GET /rest/v1/lists/{listId}/leads/ismember.json?id=309901&id=318603&id=999999
{
"requestId": "693a#17061475cf9",
"result": [
{
"id": 309901,
"status": "memberof"
},
{
"id": 318603,
"status": "notmemberof"
},
{
"id": 999999,
"status": "skipped",
"reasons": [
{
"code": "1004",
"message": "Lead not found"
}
]
}
],
"success": true
}