Listmedlemskap (statiska listor)
Slutpunktsreferens för listmedlemskap
API:erna för listmedlemskap innehåller Lead Database-slutpunkter för arbete med statiska listmedlemmar. Dessa slutpunkter kan användas för att lägga till leads till en lista, ta bort leads från en lista, hämta medlemmar i en lista och avgöra om en eller flera leads är medlemmar i en lista.
Slutpunkter
/rest/v1/lists/{listId}/leads.json/rest/v1/lists/{listId}/leads.json/rest/v1/lists/{listId}/leads.json/rest/v1/lists/{listId}/leads/ismember.jsonLägg till i listan
Slutpunkten Lägg till i listan används för att lägga till en eller flera medlemmar i en lista. Slutpunkten har en obligatorisk listId-sökvägsparameter och en eller flera id-frågeparametrar som innehåller lead-ID (maximalt tillåtet är 300).
Svaret innehåller en result-matris som består av JSON-objekt med statusen för varje lead-ID som angavs i begäran.
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
}
Ta bort från lista
Slutpunkten Ta bort från listan används för att ta bort en eller flera medlemmar från en lista. Slutpunkten har en obligatorisk listId-sökvägsparameter och en eller flera id-frågeparametrar som innehåller lead-ID (maximalt tillåtet är 300).
Svaret innehåller en result-matris som består av JSON-objekt med statusen för varje lead-ID som angavs i begäran.
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
}
Hämta leads efter list-ID
Slutpunkten Hämta leads efter list-ID används för att hämta medlemmar i en lista. Slutpunkten har en obligatorisk listId-sökvägsparameter och tillåter flera valfria frågeparametrar att ange filtervillkor.
Parametern batchSize används för att ange antalet lead-poster som ska returneras i ett enskilt anrop. Standardvärdet och maxvärdet är 300.
Parametern nextPageToken används för att paginera genom stora resultatuppsättningar. Den här parametern skickas inte i det första anropet, utan endast i efterföljande sidnumreringsanrop.
Parametern fields innehåller en kommaavgränsad lista med fältnamn som ska returneras i svaret. Om parametern fields inte ingår i denna begäran returneras följande standardfält: email, updatedAt, createdAt, lastName, firstName och id.
Svaret innehåller en result-matris som består av JSON-objekt som innehåller de lead-fält som har angetts i begäran.
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==="
}
List-medlem
Medlemmen i List-slutpunkten används för att se om en eller flera leads är medlemmar i en lista. Slutpunkten har en obligatorisk listId-sökvägsparameter och en eller flera id-frågeparametrar som innehåller lead-ID (maximalt tillåtet är 300).
Svaret innehåller en result-matris som består av JSON-objekt med statusen för varje lead-ID som angavs i begäran.
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
}