POST api/Campaigns/GetRecipientHistory

This endpoint provides a list of emails sent to the requested email addresses. It will allow up to 10 email addresses in one request. This will default to provide the emails sent over the last 90 days, but that parameter can be changed in the request.

Request Information

URI Parameters

None.

Body Parameters

Recipient model

RecipientRequestModel
NameDescriptionTypeAdditional information
EmailAddresses

The email address(es) that you want to get the list of emails sent (you can request up to 10 email addresses in one request)

Collection of string

None.

LicenseNumber

Leave this blank (this is used when returning the list of emails to Marquis’ CRM)

string

None.

StartDate

Starting date range of recipient history. If you do not provide a date, this will default to 90 days in the past

date

None.

EndDate

Ending date range of recipient history, If you do not provide a date, this will default to the current date and time

date

None.

Request Formats

application/json, text/json

Sample:
{
  "EmailAddresses": [
    "sample string 1",
    "sample string 2"
  ],
  "LicenseNumber": "sample string 1",
  "StartDate": "2025-10-23T21:22:36.842976-06:00",
  "EndDate": "2025-10-23T21:22:36.842976-06:00"
}

application/xml, text/xml

Sample:
<RecipientRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <EmailAddresses>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </EmailAddresses>
  <LicenseNumber>sample string 1</LicenseNumber>
  <StartDate>2025-10-23T21:22:36.842976-06:00</StartDate>
  <EndDate>2025-10-23T21:22:36.842976-06:00</EndDate>
</RecipientRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RecipientHistory

RecipientHistory
NameDescriptionTypeAdditional information
History

List of recipient history records

Collection of RecipientHistoryRecord

None.

HistoryCount

Number of history records returned

integer

None.

IsSuccessful

Indicator of whether the request was successful

boolean

None.

ErrorMessage

This will contain details of the error if it was not successful

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 3",
  "History": [
    {
      "EmailAddress": "sample string 1",
      "CampaignName": "sample string 2",
      "CampaignID": "sample string 3",
      "DeliveredDate": "2025-10-23T21:22:36.8586087-06:00",
      "LinkClickCount": 5,
      "RenderedEmailUrl": "sample string 6"
    },
    {
      "EmailAddress": "sample string 1",
      "CampaignName": "sample string 2",
      "CampaignID": "sample string 3",
      "DeliveredDate": "2025-10-23T21:22:36.8586087-06:00",
      "LinkClickCount": 5,
      "RenderedEmailUrl": "sample string 6"
    }
  ],
  "HistoryCount": 1
}

application/xml, text/xml

Sample:
<RecipientHistory xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IsSuccessful>true</IsSuccessful>
  <ErrorMessage>sample string 3</ErrorMessage>
  <History>
    <RecipientHistoryRecord>
      <EmailAddress>sample string 1</EmailAddress>
      <CampaignName>sample string 2</CampaignName>
      <CampaignID>sample string 3</CampaignID>
      <DeliveredDate>2025-10-23T21:22:36.8586087-06:00</DeliveredDate>
      <LinkClickCount>5</LinkClickCount>
      <RenderedEmailUrl>sample string 6</RenderedEmailUrl>
    </RecipientHistoryRecord>
    <RecipientHistoryRecord>
      <EmailAddress>sample string 1</EmailAddress>
      <CampaignName>sample string 2</CampaignName>
      <CampaignID>sample string 3</CampaignID>
      <DeliveredDate>2025-10-23T21:22:36.8586087-06:00</DeliveredDate>
      <LinkClickCount>5</LinkClickCount>
      <RenderedEmailUrl>sample string 6</RenderedEmailUrl>
    </RecipientHistoryRecord>
  </History>
  <HistoryCount>1</HistoryCount>
</RecipientHistory>