PUT api/emails/requests/{requestId}/delivery

Use this method to update delivery information on email records that were delivered to recipients by the email server

Request Information

URI Parameters

Name	Description	Type	Additional information
requestId	Email request id	integer	Required

Body Parameters

Instance of Delivery information

EmailRequestDeliveryBindingModel

Name	Description	Type	Additional information
DeliveryData		Collection of EmailDeliveryModel	None.

Request Formats

application/json, text/json

Sample:

{
  "deliveryData": [
    {
      "emailQueueItemId": 1,
      "isSuccess": true,
      "deliveryTimestamp": "2025-05-20T15:59:53.2139203-05:00",
      "deliveryError": "sample string 4"
    },
    {
      "emailQueueItemId": 1,
      "isSuccess": true,
      "deliveryTimestamp": "2025-05-20T15:59:53.2139203-05:00",
      "deliveryError": "sample string 4"
    }
  ]
}

text/html

Sample:

{"deliveryData":[{"emailQueueItemId":1,"isSuccess":true,"deliveryTimestamp":"2025-05-20T15:59:53.2139203-05:00","deliveryError":"sample string 4"},{"emailQueueItemId":1,"isSuccess":true,"deliveryTimestamp":"2025-05-20T15:59:53.2139203-05:00","deliveryError":"sample string 4"}]}

application/xml, text/xml

Sample:

<EmailRequestDeliveryBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.Emails">
  <DeliveryData>
    <EmailDeliveryModel>
      <DeliveryError>sample string 4</DeliveryError>
      <DeliveryTimestamp>2025-05-20T15:59:53.2139203-05:00</DeliveryTimestamp>
      <EmailQueueItemId>1</EmailQueueItemId>
      <IsSuccess>true</IsSuccess>
    </EmailDeliveryModel>
    <EmailDeliveryModel>
      <DeliveryError>sample string 4</DeliveryError>
      <DeliveryTimestamp>2025-05-20T15:59:53.2139203-05:00</DeliveryTimestamp>
      <EmailQueueItemId>1</EmailQueueItemId>
      <IsSuccess>true</IsSuccess>
    </EmailDeliveryModel>
  </DeliveryData>
</EmailRequestDeliveryBindingModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'EmailRequestDeliveryBindingModel'.

Response Information

Resource Description

HttpStatusCode

Response Formats

application/json, text/json, text/html

Sample:

application/xml, text/xml

Sample:

<HttpStatusCode xmlns="http://schemas.datacontract.org/2004/07/System.Net">Continue</HttpStatusCode>