GET contacts/{contactId}/communications

[HTTP GET] ~/contacts/{contactId}/communications

Description: Get all Communications a Contact has had with the Platform

Request Information

URI Parameters

Name	Description	Type	Additional information
contactId	Encrypted Contact Id	string	Required

Body Parameters

None

Response Information

Description

Successful Response - OK (200):

A List of Contact Interactions/Communications

Response Content : Collection of ContactInteraction

Name	Description	Type	Additional information
Id	The ID of the Interaction	integer	None.
Interaction	The Type of Interaction (Email, SMS, LandingPage, Event, WebForm Competition, etc...)	string	None.
Name	The Name of the Email/Sms/Webform, etc...	string	None.
Occurred	The Date the Interaction happened	date	None.
Status	The Last status of the Interaciton.	string	None.
CampaignId	The Id of the Campaign this interaction is a part of	integer	None.
CampaignName	The Name of the Campaign this interaction is a part of	string	None.

Response Codes:

200 - OK
- The specified Contact's Communications were retrieved and returned successfully.
401 - Unauthorized
- Request has been denied as it lacks valid Authentication credentials.
403 - Forbidden
- The user does not have the relevant permissions to perform this action.
404 - NotFound
- The specified Contact was not found.
500 - InternalServerError
- An error occurred while processing this request.

Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Interaction": "sample string 2",
    "Name": "sample string 3",
    "Occurred": "2024-12-27T18:06:00.6960966+00:00",
    "Status": "sample string 4",
    "CampaignId": 1,
    "CampaignName": "sample string 5"
  },
  {
    "Id": 1,
    "Interaction": "sample string 2",
    "Name": "sample string 3",
    "Occurred": "2024-12-27T18:06:00.6960966+00:00",
    "Status": "sample string 4",
    "CampaignId": 1,
    "CampaignName": "sample string 5"
  }
]

application/csp-report

Sample:

[{"Id":1,"Interaction":"sample string 2","Name":"sample string 3","Occurred":"2024-12-27T18:06:00.6960966+00:00","Status":"sample string 4","CampaignId":1,"CampaignName":"sample string 5"},{"Id":1,"Interaction":"sample string 2","Name":"sample string 3","Occurred":"2024-12-27T18:06:00.6960966+00:00","Status":"sample string 4","CampaignId":1,"CampaignName":"sample string 5"}]

application/xml, text/xml

Sample:

<ArrayOfContactInteraction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO.Contacts">
  <ContactInteraction>
    <CampaignId>1</CampaignId>
    <CampaignName>sample string 5</CampaignName>
    <Id>1</Id>
    <Interaction>sample string 2</Interaction>
    <Name>sample string 3</Name>
    <Occurred xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-12-27T18:06:00.6960966Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </Occurred>
    <Status>sample string 4</Status>
  </ContactInteraction>
  <ContactInteraction>
    <CampaignId>1</CampaignId>
    <CampaignName>sample string 5</CampaignName>
    <Id>1</Id>
    <Interaction>sample string 2</Interaction>
    <Name>sample string 3</Name>
    <Occurred xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-12-27T18:06:00.6960966Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </Occurred>
    <Status>sample string 4</Status>
  </ContactInteraction>
</ArrayOfContactInteraction>