Use these endpoints to draft individual emails, send existing messages, and check their send status. You can also find sequence outreach emails, retrieve sent email content, and review email engagement in your team's Apollo workspace.
Key concepts
| Individual and sequence emails | One-off emails are individual messages to contacts. Sequence emails are part of a planned outreach campaign. Draft and send endpoints let you send individual messages; outreach search and email stats provide information about sequence emails. |
| Identifying a message | Creating a draft returns an emailer_message object with an id. Use that message ID to send the draft, check its status, or retrieve its content after sending. A message ID identifies the email; a contact ID identifies its recipient. |
| Drafting and sending | Creating a draft saves an unsent message. Sending is a separate action processed asynchronously. A successful send response means the message was queued. Check its send status to determine whether sending completed or failed. |
| Send status and engagement | Send status describes whether a message is still being processed, completed, or failed. Engagement stats describe activity such as opens and clicks. Get email content returns sent outbound messages, rather than drafts or incoming replies. |
Choose an endpoint
| I want to . . . | Use this |
|---|---|
| Draft an individual email or a reply in an existing thread | Create an email draft |
| Send an existing drafted, scheduled, or failed message | Send email now |
| Check whether sending completed, failed, or is still being processed | Check email send status |
| Find outreach emails created for Apollo sequences | Search for outreach emails |
| Retrieve the subject, body, and recipients of up to ten sent emails | Get email content |
| Review a sequence email's content, engagement stats, and recipient details | Check email stats |
Example workflows
Draft, send, and check an individual email
Send a personalized message to a saved contact and track whether sending completes.
- Call search for contacts to find the recipient and retain their
id. - Call create an email draft with the contact ID as
contact_id, asubject, and the message inbody_html. Retain theidfrom the returnedemailer_message. - Pass that message ID as
idto send email now. - Pass the same ID to check email send status. If processing continues, wait for the returned
retry_after_secondsinterval before checking again. If sending fails, review the returned reason before retrying.
The message needs a linked sending mailbox, and the sending user needs permission to use it and email the contact. Sending limits and do not contact settings also apply.
Learn more: Use the create an email draft, send email now, and check email send status references to dig in to the workflow.
Review sequence email content and engagement
Bring sent sequence emails and their engagement details into your system to review outreach.
- Call search for outreach emails to find relevant messages and retain their
idvalues. Use filters such as sequence, date range, or email status to narrow the results. - Pass up to 10 message IDs in
idsto get email content. Match the returned subjects, bodies, and recipients to your saved message IDs. - Pass an individual message ID as
idto check email stats to review available engagement details, such as opens and clicks.
Get email content omits IDs that don't match your team's sent outbound messages. A missing result doesn't mean the request failed.
Learn more: Use the get email content and check email stats references to explore sent messages and engagement data.