Receive delivery reports

If a delivery report URL has been specified when a batch is created, status update reports will be sent to that URL as soon as they are available. The contents of these reports are described below.

Our system sends the report using POST and expects a 200 OK in response if the report was received correctly. If any response consists of a different status (for example an error status), a new attempt will be made at a later time. These retries are repeated at 10 minute intervals until one 200 OK has been received, up to 10 times. Once these 10 attempts have passed without a successful status, the report will be deleted.

Report payload

{ "messageId": "5c613848879973045cf39ac4", "emailId": "5c613848879973045cf39ac3", "recipientName": "Head Office", "recipientAddress": "info@othercorp.com", "code": 102, "duration": 0, "created": "ISO-8601 string", "reference": "A client reference" }

messageId

A unique ID for the specific message.

emailId

An ID for all the messages sent in the same request as this message.

recipientName

The name associated with the recipient's email address

recipientAddress

The recipient's email address.

code

The new status code for the message. For more information about our status codes, see the Status Codes section.

duration

Whether the status is permanent/final. If it is, then this is the last report that will be sent about this message.

created

When the status update occured (i. e. when the report was generated).

reference

This is a property that allows the user to set a custom ID or credential if storing the default generated IDs is deprecated.