GET api/messages?key={key}

For the specified recipient ID fetch all of the sent messages. Sort messages by TimeSent, from the latest to the oldest. List corresponding message Subject, From field, and document Url.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
key

Valid key for the recepient that is delivered to them via the most recent received email.

 string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of SendUntemplatedEmailMessageDTO
NameDescriptionTypeAdditional information
From

A valid e-mail address.

 string

None.
To

A valid e-mail address.

 string

None.
CarbonCopy

CC, a valid e-mail address, or a comma-separated array of e-mail addresses.

 string

None.
BlindCarbonCopy

BCC, a valid e-mail address.

 string

None.
ReplyTo

Optional reply-to e-mail address.

 string

None.
Subject

Message subject.

 string

None.
Body

Message body.

 string

None.
DocumentURL

URL where the document is stored. Must be in PDF format.

 string

None.
DocumentId

Document Id.

 string

None.
AttachmentType

Valid values are "attachment" for attachments, and "link" to add the document as a link.

 string

None.
ApplicationType

Currently supported application types: "retail". Can be null/empty if you don't want to track message status via a callback.

 string

None.
Category

E-mail template category, on the basis of which e-mail was created - optional. Can be used for footer message generation.

 string

None.
Code

E-mail template code, on the basis of which e-mail was created - optional. Can be used for footer message generation.

 string

None.
PrintDTOURL

Print DTO URL - used when DocumentURL is not specified.

 string

None.
DocumentTemplateCategory

Document template category - used when DocumentURL is not specified

 string

None.
DocumentTemplateCode

Document template code - used when DocumentURL is not specified

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "From": "sample string 1",
    "To": "sample string 2",
    "CarbonCopy": "sample string 3",
    "BlindCarbonCopy": "sample string 4",
    "ReplyTo": "sample string 5",
    "Subject": "sample string 6",
    "Body": "sample string 7",
    "DocumentURL": "sample string 8",
    "DocumentId": "sample string 9",
    "AttachmentType": "sample string 10",
    "ApplicationType": "sample string 11",
    "Category": "sample string 12",
    "Code": "sample string 13",
    "PrintDTOURL": "sample string 14",
    "DocumentTemplateCategory": "sample string 15",
    "DocumentTemplateCode": "sample string 16"
  },
  {
    "From": "sample string 1",
    "To": "sample string 2",
    "CarbonCopy": "sample string 3",
    "BlindCarbonCopy": "sample string 4",
    "ReplyTo": "sample string 5",
    "Subject": "sample string 6",
    "Body": "sample string 7",
    "DocumentURL": "sample string 8",
    "DocumentId": "sample string 9",
    "AttachmentType": "sample string 10",
    "ApplicationType": "sample string 11",
    "Category": "sample string 12",
    "Code": "sample string 13",
    "PrintDTOURL": "sample string 14",
    "DocumentTemplateCategory": "sample string 15",
    "DocumentTemplateCode": "sample string 16"
  }
]

text/html

Sample: 
[{"From":"sample string 1","To":"sample string 2","CarbonCopy":"sample string 3","BlindCarbonCopy":"sample string 4","ReplyTo":"sample string 5","Subject":"sample string 6","Body":"sample string 7","DocumentURL":"sample string 8","DocumentId":"sample string 9","AttachmentType":"sample string 10","ApplicationType":"sample string 11","Category":"sample string 12","Code":"sample string 13","PrintDTOURL":"sample string 14","DocumentTemplateCategory":"sample string 15","DocumentTemplateCode":"sample string 16"},{"From":"sample string 1","To":"sample string 2","CarbonCopy":"sample string 3","BlindCarbonCopy":"sample string 4","ReplyTo":"sample string 5","Subject":"sample string 6","Body":"sample string 7","DocumentURL":"sample string 8","DocumentId":"sample string 9","AttachmentType":"sample string 10","ApplicationType":"sample string 11","Category":"sample string 12","Code":"sample string 13","PrintDTOURL":"sample string 14","DocumentTemplateCategory":"sample string 15","DocumentTemplateCode":"sample string 16"}]

application/xml, text/xml

Sample: 
<ArrayOfSendUntemplatedEmailMessageDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
  <SendUntemplatedEmailMessageDTO>
    <ApplicationType>sample string 11</ApplicationType>
    <AttachmentType>sample string 10</AttachmentType>
    <BlindCarbonCopy>sample string 4</BlindCarbonCopy>
    <Body>sample string 7</Body>
    <CarbonCopy>sample string 3</CarbonCopy>
    <Category>sample string 12</Category>
    <Code>sample string 13</Code>
    <DocumentId>sample string 9</DocumentId>
    <DocumentTemplateCategory>sample string 15</DocumentTemplateCategory>
    <DocumentTemplateCode>sample string 16</DocumentTemplateCode>
    <DocumentURL>sample string 8</DocumentURL>
    <From>sample string 1</From>
    <PrintDTOURL>sample string 14</PrintDTOURL>
    <ReplyTo>sample string 5</ReplyTo>
    <Subject>sample string 6</Subject>
    <To>sample string 2</To>
  </SendUntemplatedEmailMessageDTO>
  <SendUntemplatedEmailMessageDTO>
    <ApplicationType>sample string 11</ApplicationType>
    <AttachmentType>sample string 10</AttachmentType>
    <BlindCarbonCopy>sample string 4</BlindCarbonCopy>
    <Body>sample string 7</Body>
    <CarbonCopy>sample string 3</CarbonCopy>
    <Category>sample string 12</Category>
    <Code>sample string 13</Code>
    <DocumentId>sample string 9</DocumentId>
    <DocumentTemplateCategory>sample string 15</DocumentTemplateCategory>
    <DocumentTemplateCode>sample string 16</DocumentTemplateCode>
    <DocumentURL>sample string 8</DocumentURL>
    <From>sample string 1</From>
    <PrintDTOURL>sample string 14</PrintDTOURL>
    <ReplyTo>sample string 5</ReplyTo>
    <Subject>sample string 6</Subject>
    <To>sample string 2</To>
  </SendUntemplatedEmailMessageDTO>
</ArrayOfSendUntemplatedEmailMessageDTO>