Returns status information for a single message based on UID.
Request Fields
These are passed in at the top level of the request.
Key | Type | Description |
---|---|---|
uid | string | Identifier of the message to retrieve. |
Request Example
{
"api_key": "PROJECT_API_KEY",
"arguments": {
"uid": "MESSAGE_UID"
}
}
The messages have a status of one of the following:
queued
One or more of the emails in this batch are still being delivered.failed
One or more of the emails in this batch could not be delivered.completed
The batch was successfully processed and delivered.
Response 200 OK
{
"response" : {
"status" : "ok",
"uid": "MESSAGE_UID",
"delivery_status": "completed"
}
}
Response 404 Not Found
{
"response": {
"status": "not_found",
"message": "Message with UID MESSAGE_UID was not found."
}
}