Get Contact History In Mailing List
GET {{baseUrl}}/directories/:directoryId/mailinglists/:mailingListId/contacts/:contactId/history?type=response&skipToken=<string>&pageSize=100
Retrieve the history for contacts in a mailing list. <!--From Readme--> For the last page of results, the value associated with nextPage will be null. <!-- theme: warning -->
This API call is only available to XM Directory users.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
type | string | (Required) The desired history type; one of two values: email and response | |
skipToken | string | The start position for pagination | |
pageSize | number | The maximum number of items to return per request |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"result":{"elements":[{"distributionId":"\u003cstring\u003e","date":"\u003cdateTime\u003e","type":"\u003cstring\u003e","result":"Failure","bounceInfo":{"type":"\u003cstring\u003e","statusCode":"\u003cstring\u003e","reason":"\u003cstring\u003e","blacklisted":"\u003cboolean\u003e"},"surveyId":"\u003cstring\u003e","read":"\u003cboolean\u003e","lookupId":"\u003cstring\u003e","responseId":"\u003cstring\u003e","surveyStartedDate":"\u003cdateTime\u003e","surveyCompletedDate":"\u003cdateTime\u003e","surveyFinished":"\u003cboolean\u003e"},{"distributionId":"\u003cstring\u003e","date":"\u003cdateTime\u003e","type":"\u003cstring\u003e","result":"Unknown","bounceInfo":{"type":"\u003cstring\u003e","statusCode":"\u003cstring\u003e","reason":"\u003cstring\u003e","blacklisted":"\u003cboolean\u003e"},"surveyId":"\u003cstring\u003e","read":"\u003cboolean\u003e","lookupId":"\u003cstring\u003e","responseId":"\u003cstring\u003e","surveyStartedDate":"\u003cdateTime\u003e","surveyCompletedDate":"\u003cdateTime\u003e","surveyFinished":"\u003cboolean\u003e"}],"nextPage":"\u003cstring\u003e"},"meta":{"httpStatus":"\u003cstring\u003e","requestId":"\u003cstring\u003e","notice":"\u003cstring\u003e"}}