GET /messaging/v1/email/messages/{messageKey}
Retrieves the send status for an email.
Requests to this endpoint are rate-limited. To monitor message statuses in real time, subscribe to transactional send events using Event Notification Service.
| Name | Type | Description |
|---|---|---|
messageKey | string | Required. The unique identifier for the message. |
When you send a message, you must provide a messageKey that’s unique among all of the keys used in your business unit over the last 2 days.
You can use this GET request to retrieve statuses for messages that are up to 3 days old. If more than one message was sent using the same message key, the API returns the status of the message that was sent most recently.
For real-time tracking of message statuses and other events, we recommend that you subscribe to transactional send events using Event Notification Service.
| Status | Name | Type | Description |
|---|---|---|---|
| 200 | OK | ||
| requestId | string | The unique identifier of the request. | |
| eventCategoryType | string | The status of the message. A status of EmailSent indicates that the email was sent to the email provider. EmailNotSent indicates that the email wasn’t sent and includes the reason. EmailQueued indicates that the email hasn’t yet been processed for sending. | |
| timestamp | string | The time the event occurred in Central Standard Time. Daylight saving time (DST) isn’t applied. | |
| messageKey | string | A unique identifier to track the status of the message. | |
| compositeId | string | An internal ID. If you contact Salesforce Support to troubleshoot email delivery issues, provide this ID. | |
| contactKey | string | The unique Marketing Cloud Engagement identifier for the subscriber. | |
| to | string | The email address of the recipient. |
To retrieve information about the status of a message, issue a GET request. Include the unique messageKey in the URL.
If the message has been sent to the outbound mail service for delivery, the response indicates an eventCategoryType of EmailSent.
If the message is queued for processing, the response indicates an eventCategoryType of EmailQueued.
If the message isn’t sent, the response indicates an eventCategoryType of EmailNotSent. The info object provides more information about the error that prevented the message from being sent.