GET api/emails/requests?StartDate={StartDate}&EndDate={EndDate}
This method should return a filtered collection of submitted email requests; filtered by the start date and end date
Requires Authorization!
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
StartDate | date |
None. |
|
EndDate | date |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of Collection of submitted email requests
Collection of EmailRequestHistoryResponseModelName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
EmailRequestId | integer |
None. |
|
EmailDeliveryStatusId | integer |
None. |
|
EmailDeliveryStatus | string |
None. |
|
FromEmail | string |
None. |
|
ToEmail | string |
None. |
|
RecipientName | string |
None. |
|
SubjectLine | string |
None. |
|
Body | string |
None. |
|
IsHtml | boolean |
None. |
|
AttachmentUrils | Collection of string |
None. |
|
UserPropertyId | integer |
None. |
|
Pin | string |
None. |
|
AddressFull | string |
None. |
|
DeliveryDate | date |
None. |
|
DeliveryError | string |
None. |
|
AddedDate | date |
None. |
Response Formats
application/json, text/json
Sample:
[ { "id": 1, "emailRequestId": 2, "emailDeliveryStatusId": 3, "emailDeliveryStatus": "sample string 4", "fromEmail": "sample string 5", "toEmail": "sample string 6", "recipientName": "sample string 7", "subjectLine": "sample string 8", "body": "sample string 9", "isHtml": true, "attachmentUrils": [ "sample string 1", "sample string 2" ], "userPropertyId": 11, "pin": "sample string 12", "addressFull": "sample string 13", "deliveryDate": "2025-05-20T15:21:24.4187328-05:00", "deliveryError": "sample string 14", "addedDate": "2025-05-20T15:21:24.4208173-05:00" }, { "id": 1, "emailRequestId": 2, "emailDeliveryStatusId": 3, "emailDeliveryStatus": "sample string 4", "fromEmail": "sample string 5", "toEmail": "sample string 6", "recipientName": "sample string 7", "subjectLine": "sample string 8", "body": "sample string 9", "isHtml": true, "attachmentUrils": [ "sample string 1", "sample string 2" ], "userPropertyId": 11, "pin": "sample string 12", "addressFull": "sample string 13", "deliveryDate": "2025-05-20T15:21:24.4187328-05:00", "deliveryError": "sample string 14", "addedDate": "2025-05-20T15:21:24.4208173-05:00" } ]
text/html
Sample:
[{"id":1,"emailRequestId":2,"emailDeliveryStatusId":3,"emailDeliveryStatus":"sample string 4","fromEmail":"sample string 5","toEmail":"sample string 6","recipientName":"sample string 7","subjectLine":"sample string 8","body":"sample string 9","isHtml":true,"attachmentUrils":["sample string 1","sample string 2"],"userPropertyId":11,"pin":"sample string 12","addressFull":"sample string 13","deliveryDate":"2025-05-20T15:21:24.4187328-05:00","deliveryError":"sample string 14","addedDate":"2025-05-20T15:21:24.4208173-05:00"},{"id":1,"emailRequestId":2,"emailDeliveryStatusId":3,"emailDeliveryStatus":"sample string 4","fromEmail":"sample string 5","toEmail":"sample string 6","recipientName":"sample string 7","subjectLine":"sample string 8","body":"sample string 9","isHtml":true,"attachmentUrils":["sample string 1","sample string 2"],"userPropertyId":11,"pin":"sample string 12","addressFull":"sample string 13","deliveryDate":"2025-05-20T15:21:24.4187328-05:00","deliveryError":"sample string 14","addedDate":"2025-05-20T15:21:24.4208173-05:00"}]
application/xml, text/xml
Sample:
<ArrayOfEmailRequestHistoryResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.Emails"> <EmailRequestHistoryResponseModel> <AddedDate>2025-05-20T15:21:24.4208173-05:00</AddedDate> <AddressFull>sample string 13</AddressFull> <AttachmentUrils xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </AttachmentUrils> <Body>sample string 9</Body> <DeliveryDate>2025-05-20T15:21:24.4187328-05:00</DeliveryDate> <DeliveryError>sample string 14</DeliveryError> <EmailDeliveryStatus>sample string 4</EmailDeliveryStatus> <EmailDeliveryStatusId>3</EmailDeliveryStatusId> <EmailRequestId>2</EmailRequestId> <FromEmail>sample string 5</FromEmail> <Id>1</Id> <IsHtml>true</IsHtml> <Pin>sample string 12</Pin> <RecipientName>sample string 7</RecipientName> <SubjectLine>sample string 8</SubjectLine> <ToEmail>sample string 6</ToEmail> <UserPropertyId>11</UserPropertyId> </EmailRequestHistoryResponseModel> <EmailRequestHistoryResponseModel> <AddedDate>2025-05-20T15:21:24.4208173-05:00</AddedDate> <AddressFull>sample string 13</AddressFull> <AttachmentUrils xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </AttachmentUrils> <Body>sample string 9</Body> <DeliveryDate>2025-05-20T15:21:24.4187328-05:00</DeliveryDate> <DeliveryError>sample string 14</DeliveryError> <EmailDeliveryStatus>sample string 4</EmailDeliveryStatus> <EmailDeliveryStatusId>3</EmailDeliveryStatusId> <EmailRequestId>2</EmailRequestId> <FromEmail>sample string 5</FromEmail> <Id>1</Id> <IsHtml>true</IsHtml> <Pin>sample string 12</Pin> <RecipientName>sample string 7</RecipientName> <SubjectLine>sample string 8</SubjectLine> <ToEmail>sample string 6</ToEmail> <UserPropertyId>11</UserPropertyId> </EmailRequestHistoryResponseModel> </ArrayOfEmailRequestHistoryResponseModel>