목록 멤버십(정적 목록)
목록 멤버십 API는 정적 목록 멤버로 작업할 수 있는 리드 데이터베이스 엔드포인트를 제공합니다. 이러한 엔드포인트는 리드를 목록에 추가하고, 목록에서 리드를 제거하고, 목록의 멤버를 검색하고, 하나 이상의 리드가 목록의 멤버인지 여부를 확인하는 데 사용할 수 있습니다.
엔드포인트
/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목록에 추가
목록에 추가 끝점은 목록에 하나 이상의 구성원을 추가하는 데 사용됩니다. 끝점은 필수 listId 경로 매개 변수와 리드 ID가 포함된 하나 이상의 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
}
목록에서 제거
목록에서 제거 끝점은 목록에서 하나 이상의 구성원을 제거하는 데 사용됩니다. 끝점은 필수 listId 경로 매개 변수와 리드 ID가 포함된 하나 이상의 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 매개 변수는 단일 호출에서 반환할 잠재 고객 레코드 수를 지정하는 데 사용됩니다. 기본값과 최대값은 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==="
}
목록 구성원
Member of List 끝점은 하나 이상의 리드가 목록의 구성원인지 확인하는 데 사용됩니다. 끝점은 필수 listId 경로 매개 변수와 리드 ID가 포함된 하나 이상의 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
}