GET contacts/{contactId}/emails

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

Description: Get a list of a Contact's Email Interactions

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 collection of ContactEmailDTO

Response Content : Collection of ContactEmail

Name	Description	Type	Additional information
Id	The id of the Email	integer	None.
Name	The Name of the Email	string	None.
Date	The date of interaction	date	None.
Delivered	Was the email delivered	integer	None.
Open	Was the Email opened	integer	None.
Read	Was the Email read	integer	None.
Link	Was an Email link clicked	integer	None.

Response Codes:

200 - OK
- The specified Contact's Email Interactions 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,
    "Name": "sample string 2",
    "Date": "2024-05-06T10:08:14.1957879+01:00",
    "Delivered": 1,
    "Open": 1,
    "Read": 1,
    "Link": 1
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "Date": "2024-05-06T10:08:14.1957879+01:00",
    "Delivered": 1,
    "Open": 1,
    "Read": 1,
    "Link": 1
  }
]

application/csp-report

Sample:

[{"Id":1,"Name":"sample string 2","Date":"2024-05-06T10:08:14.1957879+01:00","Delivered":1,"Open":1,"Read":1,"Link":1},{"Id":1,"Name":"sample string 2","Date":"2024-05-06T10:08:14.1957879+01:00","Delivered":1,"Open":1,"Read":1,"Link":1}]

application/xml, text/xml

Sample:

<ArrayOfContactEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO.Contacts">
  <ContactEmail>
    <Date xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-06T09:08:14.1957879Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>60</d3p1:OffsetMinutes>
    </Date>
    <Delivered>1</Delivered>
    <Id>1</Id>
    <Link>1</Link>
    <Name>sample string 2</Name>
    <Open>1</Open>
    <Read>1</Read>
  </ContactEmail>
  <ContactEmail>
    <Date xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-06T09:08:14.1957879Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>60</d3p1:OffsetMinutes>
    </Date>
    <Delivered>1</Delivered>
    <Id>1</Id>
    <Link>1</Link>
    <Name>sample string 2</Name>
    <Open>1</Open>
    <Read>1</Read>
  </ContactEmail>
</ArrayOfContactEmail>