POST api/email/checkStatus

Makes a request to check on the send status of an email.

Request Information

URI Parameters

None.

Body Parameters

A request describing which emails to check.

GetEmailStatusRequest
NameDescriptionTypeAdditional information
ApplicationId

The ApplicationId used when submitting the email(s) to check.

 integer

Required
ReferenceIds

An array of reference ids used when submitting the emails.

 Collection of integer

Required

Maximum Count: 50

Minimum Count: 1

Request Formats

application/json, text/json

Sample: 
{
  "ApplicationId": 1,
  "ReferenceIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample: 
<GetEmailStatusRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ApplicationId>1</ApplicationId>
  <ReferenceIds>
    <int>1</int>
    <int>2</int>
  </ReferenceIds>
</GetEmailStatusRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An object containing the status of the emails requested.

GetEmailStatusResponse
NameDescriptionTypeAdditional information
Results

The results of the email check

 Collection of EmailStatus

None.

Response Formats

application/json, text/json

Sample: 
{
  "Results": [
    {
      "ApplicationId": 1,
      "ReferenceId": 2,
      "Status": 0,
      "ErrorMessage": "sample string 3",
      "To": "sample string 4",
      "Subject": "sample string 5",
      "EmailQueued": "2024-12-25T09:31:13.4756229-05:00",
      "EmailSent": "2024-12-25T09:31:13.4756229-05:00"
    },
    {
      "ApplicationId": 1,
      "ReferenceId": 2,
      "Status": 0,
      "ErrorMessage": "sample string 3",
      "To": "sample string 4",
      "Subject": "sample string 5",
      "EmailQueued": "2024-12-25T09:31:13.4756229-05:00",
      "EmailSent": "2024-12-25T09:31:13.4756229-05:00"
    }
  ]
}

application/xml, text/xml

Sample: 
<GetEmailStatusResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Results>
    <EmailStatus>
      <ApplicationId>1</ApplicationId>
      <ReferenceId>2</ReferenceId>
      <Status>Pending</Status>
      <ErrorMessage>sample string 3</ErrorMessage>
      <To>sample string 4</To>
      <Subject>sample string 5</Subject>
      <EmailQueued>2024-12-25T09:31:13.4756229-05:00</EmailQueued>
      <EmailSent>2024-12-25T09:31:13.4756229-05:00</EmailSent>
    </EmailStatus>
    <EmailStatus>
      <ApplicationId>1</ApplicationId>
      <ReferenceId>2</ReferenceId>
      <Status>Pending</Status>
      <ErrorMessage>sample string 3</ErrorMessage>
      <To>sample string 4</To>
      <Subject>sample string 5</Subject>
      <EmailQueued>2024-12-25T09:31:13.4756229-05:00</EmailQueued>
      <EmailSent>2024-12-25T09:31:13.4756229-05:00</EmailSent>
    </EmailStatus>
  </Results>
</GetEmailStatusResponse>