GET api/emails/requests/{requestId}/delivery?count={count}
Use thid method to retrieve X number of emails pending delivery per original email request
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
requestId |
Email request id |
integer |
Required |
count |
Record count |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of Email Objects
Collection of EmailQueueEntryResponseModelName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
FromEmail | string |
None. |
|
ToEmail | string |
None. |
|
SubjectLine | string |
None. |
|
Body | string |
None. |
|
IsHtml | boolean |
None. |
|
AttachmentUrls | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "id": 1, "fromEmail": "sample string 2", "toEmail": "sample string 3", "subjectLine": "sample string 4", "body": "sample string 5", "isHtml": true, "attachmentUrls": [ "sample string 1", "sample string 2" ] }, { "id": 1, "fromEmail": "sample string 2", "toEmail": "sample string 3", "subjectLine": "sample string 4", "body": "sample string 5", "isHtml": true, "attachmentUrls": [ "sample string 1", "sample string 2" ] } ]
text/html
Sample:
[{"id":1,"fromEmail":"sample string 2","toEmail":"sample string 3","subjectLine":"sample string 4","body":"sample string 5","isHtml":true,"attachmentUrls":["sample string 1","sample string 2"]},{"id":1,"fromEmail":"sample string 2","toEmail":"sample string 3","subjectLine":"sample string 4","body":"sample string 5","isHtml":true,"attachmentUrls":["sample string 1","sample string 2"]}]
application/xml, text/xml
Sample:
<ArrayOfEmailQueueEntryResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.Emails"> <EmailQueueEntryResponseModel> <AttachmentUrls xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </AttachmentUrls> <Body>sample string 5</Body> <FromEmail>sample string 2</FromEmail> <Id>1</Id> <IsHtml>true</IsHtml> <SubjectLine>sample string 4</SubjectLine> <ToEmail>sample string 3</ToEmail> </EmailQueueEntryResponseModel> <EmailQueueEntryResponseModel> <AttachmentUrls xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </AttachmentUrls> <Body>sample string 5</Body> <FromEmail>sample string 2</FromEmail> <Id>1</Id> <IsHtml>true</IsHtml> <SubjectLine>sample string 4</SubjectLine> <ToEmail>sample string 3</ToEmail> </EmailQueueEntryResponseModel> </ArrayOfEmailQueueEntryResponseModel>