v1

latestOpenAPI 3.1.02026-07-247601.0 MB
Emailer Messages

Check Email Send Status

Use the Check Email Send Status endpoint to check the current delivery status of an email message. This is typically used after calling the <a href="https://docs.apollo.io/reference/send-email-now" target="_blank">Send Email Now endpoint</a>, since emails are sent asynchronously and a successful send response only means the email was queued. <br><br>You must provide the id of the email message. The message must belong to your team, otherwise a 404 is returned. <br><br>The response always includes the message id, its current status, and a human-readable message. The remaining fields depend on the status: <ul> <li> If the email was delivered (completed), a completed_at timestamp is included. </li> <li> If the email failed (failed), a not_sent_reason, failure_reason, and failed_at timestamp may be included. </li> <li> If the email is still being processed (e.g. drafted or scheduled), a retry_after_seconds value is included to indicate how long to wait before checking again. </li> </ul>

post/emailer_messages/email_send_status

Request body

idstring required

The Apollo ID of the email message to check. This is the id returned when you create an email draft or send an email. <br><br>Example: 66e8cc45028aed019c25d724

Response

200

idstring
statusstring
messagestring
completed_atstring date-time
not_sent_reasonstring
failure_reasonstring
failed_atstring date-time
retry_after_secondsinteger

Example response

{
  "id": "66e8cc45028aed019c25d724",
  "status": "completed",
  "message": "Email delivered successfully.",
  "completed_at": "2025-02-03T15:30:00Z",
  "not_sent_reason": "no_active_email_account",
  "failure_reason": "Mailbox disconnected",
  "failed_at": "2025-02-03T15:30:00Z",
  "retry_after_seconds": 10
}