POST api/Campaigns/GetSentEmails

This method will return a list of emails that were sent on the requested date. It requires a range. In this range, up to 5000 can be requested at a time.

Request Information

URI Parameters

None.

Body Parameters

SentEmailsRequestModel

SentEmailsRequestModel
NameDescriptionTypeAdditional information
DeliveryDate

The date the emails were sent on

date

Required

StartRange

Beginning range of sent emails. The difference in the beginning and end range must be 5000 or less.

integer

Required

EndRange

End range of sent emails. The difference in the beginning and end range must be 5000 or less.

integer

Required

IncludeEmailLink

Include a url which renders the delivered email.

boolean

Required

Request Formats

application/json, text/json

Sample:
{
  "DeliveryDate": "2025-10-23T21:21:27.6836774-06:00",
  "StartRange": 2,
  "EndRange": 3,
  "IncludeEmailLink": true
}

application/xml, text/xml

Sample:
<SentEmailsRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DeliveryDate>2025-10-23T21:21:27.6836774-06:00</DeliveryDate>
  <StartRange>2</StartRange>
  <EndRange>3</EndRange>
  <IncludeEmailLink>true</IncludeEmailLink>
</SentEmailsRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SentEmailsResponseModel
NameDescriptionTypeAdditional information
Count

Count of how many delivery records are returned in the response.

integer

None.

DailyCount

Count of how many deliveries occurred on the requested day.

integer

None.

Deliveries

List of deliveries

Collection of Delivery

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 4",
  "Count": 1,
  "DailyCount": 2,
  "Deliveries": null
}