API Reference
Complete reference of every section and operation in the Mailyte API.
Sending
Submit messages for delivery, individually or in batches.
Operations
- POSTSend a message
/api/v1/messages - GETList scheduled messages
/api/v1/messages/scheduled - POSTSend a batch of messages
/api/v1/messages/batch - POSTSchedule a message
/api/v1/messages/scheduled - GETRetrieve a message
/api/v1/messages/scheduled/{scheduled} - DELETECancel a scheduled message
/api/v1/messages/scheduled/{scheduled} - GETRetrieve a stored message
/api/v1/domains/{domain}/messages/{messageId}
Templates
Stored templates with variables, rendered at send time.
Operations
- GETList templates
/api/v1/email-templates - POSTCreate a email template
/api/v1/email-templates - GETRetrieve a email template
/api/v1/email-templates/{email_template} - POSTPreview a rendered template
/api/v1/email-templates/preview - PUTUpdate a email template
/api/v1/email-templates/{email_template} - PATCHUpdate a email template
/api/v1/email-templates/{email_template} - DELETEDelete a email template
/api/v1/email-templates/{email_template}
Events
What happened to a message after you submitted it.
Operations
- GETList delivery events
/api/v1/email-logs - GETRetrieve a email log
/api/v1/email-logs/{event} - GETMessages (email log)
/api/v1/email-logs/messages - DELETEDelete a delivery event
/api/v1/email-logs/{event} - GETGet a message timeline
/api/v1/email-logs/messages/{messageKey} - POSTResend a message
/api/v1/email-logs/{event}/resend
Suppressions
Addresses Mailyte will refuse to send to, and why.
Webhooks
Receive delivery events at your own endpoint as they happen.
SMTP credentials
Logins for applications that relay over SMTP rather than HTTP.
Operations
- GETList smtp credentials
/api/v1/smtp-credentials - POSTCreate an SMTP credential
/api/v1/smtp-credentials - PATCHUpdate a smtp credential
/api/v1/smtp-credentials/{credential} - DELETEDelete a smtp credential
/api/v1/smtp-credentials/{credential} - GETUsage a smtp credential
/api/v1/smtp-credentials/{credential}/usage - POSTEnable a smtp credential
/api/v1/smtp-credentials/{credential}/enable - POSTResume a paused SMTP credential
/api/v1/smtp-credentials/{credential}/resume - POSTRevoke a smtp credential
/api/v1/smtp-credentials/{credential}/revoke - POSTRotate a smtp credential
/api/v1/smtp-credentials/{credential}/rotate - PUTReplace an SMTP credential's IP allowlist
/api/v1/smtp-credentials/{credential}/ip-allowlist
Reports
Deliverability, engagement and volume reporting.
Operations
- GETList deliverabilitys
/api/v1/deliverability - GETDomain Health (report)
/api/v1/reports/domain-health - GETEmail Delivery (report)
/api/v1/reports/email-delivery - GETEngagement (report)
/api/v1/reports/engagement - GETHistory (report)
/api/v1/reports/history - GETSecurity (report)
/api/v1/reports/security - GETTemplates (report)
/api/v1/reports/templates - GETVolume Trends (report)
/api/v1/reports/volume-trends - POSTGenerate (report)
/api/v1/reports/generate
Sandbox inboxes
Operations for sandbox inboxes.
Operations
- GETList sandbox inboxes
/api/v1/sandbox/inboxes - GETGet sandbox usage
/api/v1/sandbox/usage - POSTCreate a sandbox inbox
/api/v1/sandbox/inboxes - GETGet a sandbox inbox
/api/v1/sandbox/inboxes/{id} - PATCHUpdate a sandbox inbox
/api/v1/sandbox/inboxes/{id} - DELETEDelete a sandbox inbox
/api/v1/sandbox/inboxes/{id} - GETGet a sandbox inbox's SMTP credentials
/api/v1/sandbox/inboxes/{id}/credentials - GETGet a sandbox inbox's public link and access code
/api/v1/sandbox/inboxes/{id}/share - POSTEmpty a sandbox inbox
/api/v1/sandbox/inboxes/{id}/empty - POSTReset a sandbox inbox's SMTP credentials
/api/v1/sandbox/inboxes/{id}/reset-credentials - PATCHTurn a sandbox inbox's public link or access code on or off
/api/v1/sandbox/inboxes/{id}/share - POSTGive a sandbox inbox a new access code
/api/v1/sandbox/inboxes/{id}/share/new-code - POSTGive a sandbox inbox a new public link
/api/v1/sandbox/inboxes/{id}/share/reset-link
Sandbox messages
Operations for sandbox messages.
Operations
- GETGet a sandbox message
/api/v1/sandbox/messages/{id} - PATCHMark a sandbox message read or unread
/api/v1/sandbox/messages/{id} - DELETEDelete a sandbox message
/api/v1/sandbox/messages/{id} - GETList messages in a sandbox inbox
/api/v1/sandbox/inboxes/{id}/messages - GETDownload a sandbox message as .eml
/api/v1/sandbox/messages/{id}/raw - POSTSimulate a delivery event on a sandbox message
/api/v1/sandbox/messages/{id}/events - GETWait for a sandbox message
/api/v1/sandbox/inboxes/{id}/messages/await - GETDownload a sandbox message attachment
/api/v1/sandbox/messages/{id}/attachments/{index}
Sandbox webhooks
Operations for sandbox webhooks.
Operations
- GETList sandbox webhooks
/api/v1/sandbox/webhooks - POSTCreate a sandbox webhook
/api/v1/sandbox/webhooks - PATCHUpdate a sandbox webhook
/api/v1/sandbox/webhooks/{id} - DELETEDelete a sandbox webhook
/api/v1/sandbox/webhooks/{id} - GETList a sandbox webhook's delivery attempts
/api/v1/sandbox/webhooks/{id}/deliveries - POSTSend a test sandbox webhook
/api/v1/sandbox/webhooks/{id}/test
Mailboxes
Provision mailboxes, aliases and forwarding for a domain.
Operations
- GETList email accounts
/api/v1/email-accounts - POSTCreate a mailbox
/api/v1/email-accounts - GETRetrieve a email account
/api/v1/email-accounts/{email_account} - POSTBulk Update (email account)
/api/v1/email-accounts/bulk-update - PUTUpdate a email account
/api/v1/email-accounts/{email_account} - PATCHUpdate a email account
/api/v1/email-accounts/{email_account} - DELETEDelete a email account
/api/v1/email-accounts/{email_account} - GETOverview a email account
/api/v1/email-accounts/{account}/overview - GETStats a email account
/api/v1/email-accounts/{account}/stats - POSTGenerate Password a email account
/api/v1/email-accounts/{account}/generate-password - POSTReset Password a email account
/api/v1/email-accounts/{account}/reset-password - POSTRetry provisioning a mailbox
/api/v1/email-accounts/{account}/retry-provisioning
Mailbox aliases & routing
Operations for mailbox aliases & routing.
Operations
- GETList a mailbox's aliases
/api/v1/email-accounts/{account}/aliases - GETList forwarding rules
/api/v1/email-accounts/{account}/forwarding-rules - POSTAdd an alias
/api/v1/email-accounts/{account}/aliases - POSTCreate a forwarding rule
/api/v1/email-accounts/{account}/forwarding-rules - PUTUpdate a forwarding rule
/api/v1/email-accounts/{account}/forwarding-rules/{rule} - DELETEDelete a mailbox alias
/api/v1/email-accounts/{account}/aliases/{alias} - DELETEDelete a forwarding rule
/api/v1/email-accounts/{account}/forwarding-rules/{rule} - POSTRetry provisioning an alias
/api/v1/email-accounts/{account}/aliases/{alias}/retry-provisioning
Mailbox API
Everything the webmail does, for one mailbox. Takes a mailbox token, not an organization API key.
These endpoints take a mailbox token, not an organization API key — they act as one mailbox holder. See Authentication.
Mailbox auth & security
Operations for mailbox auth & security.
These endpoints take a mailbox token, not an organization API key — they act as one mailbox holder. See Authentication.
Operations
- GETThe mailbox holder's security state
/api/v1/mailbox/security - POSTSign in to the webmail with mailbox credentials
/api/v1/mailbox-auth/login - POSTEnd the current webmail session
/api/v1/mailbox-auth/logout - GETWhere this mailbox is signed in
/api/v1/mailbox/security/sessions - POSTChange this mailbox's password
/api/v1/mailbox/security/password - POSTStart two-factor enrolment
/api/v1/mailbox/security/2fa/begin - POSTConfirm two-factor enrolment with a code
/api/v1/mailbox/security/2fa/confirm - POSTTurn two-factor off
/api/v1/mailbox/security/2fa/disable - DELETESign out another device
/api/v1/mailbox/security/sessions/{session_id}
Mailbox messages
Operations for mailbox messages.
These endpoints take a mailbox token, not an organization API key — they act as one mailbox holder. See Authentication.
Operations
- GETList messages in a folder
/api/v1/mailbox/messages - GETRead one message
/api/v1/mailbox/messages/{message_id} - GETMessages waiting to be sent
/api/v1/mailbox/messages/scheduled - POSTSave a draft
/api/v1/mailbox/messages/draft - POSTSend a message
/api/v1/mailbox/messages/send - DELETEPermanently delete a message
/api/v1/mailbox/messages/{message_id} - GETList a message's attachments
/api/v1/mailbox/messages/{message_id}/attachments - GETWho this message is with, and the shape of its conversation
/api/v1/mailbox/messages/{message_id}/context - GETDownload the original message (RFC 822)
/api/v1/mailbox/messages/{message_id}/raw - GETThe conversation a message belongs to
/api/v1/mailbox/messages/{message_id}/thread - POSTMark a message read
/api/v1/mailbox/messages/{message_id}/mark-read - POSTMark a message unread
/api/v1/mailbox/messages/{message_id}/mark-unread - POSTMove a message to another folder
/api/v1/mailbox/messages/{message_id}/move - POSTStar a message
/api/v1/mailbox/messages/{message_id}/star - POSTMove a message to Trash
/api/v1/mailbox/messages/{message_id}/trash - POSTUnstar a message
/api/v1/mailbox/messages/{message_id}/unstar - DELETEDiscard a draft
/api/v1/mailbox/messages/draft/{message_id} - DELETECancel a scheduled send
/api/v1/mailbox/messages/scheduled/{message_id} - GETDownload one attachment
/api/v1/mailbox/messages/{message_id}/attachments/{index}
Mailbox folders
Operations for mailbox folders.
These endpoints take a mailbox token, not an organization API key — they act as one mailbox holder. See Authentication.
Mailbox contacts
Operations for mailbox contacts.
These endpoints take a mailbox token, not an organization API key — they act as one mailbox holder. See Authentication.
Operations
- GETAddresses this mailbox has written to
/api/v1/mailbox/contacts - GETAddress books this mailbox can see
/api/v1/mailbox/address-book/books - GETSaved contacts
/api/v1/mailbox/address-book/contacts - POSTSave a contact
/api/v1/mailbox/address-book/contacts - GETOne contact
/api/v1/mailbox/address-book/contacts/{card_id} - PUTReplace a contact
/api/v1/mailbox/address-book/contacts/{card_id} - DELETEDelete a contact
/api/v1/mailbox/address-book/contacts/{card_id}
Mailbox calendars
Operations for mailbox calendars.
These endpoints take a mailbox token, not an organization API key — they act as one mailbox holder. See Authentication.
Operations
- GETSubscription links for this mailbox
/api/v1/mailbox/calendar-subscriptions - GETCalendars in this mailbox
/api/v1/mailbox/calendars - POSTCreate a subscription link
/api/v1/mailbox/calendar-subscriptions - GETInvitations awaiting an answer
/api/v1/mailbox/calendar/invitations - GETRooms and equipment you can invite
/api/v1/mailbox/calendar/rooms - POSTWhen are these people busy
/api/v1/mailbox/calendar/free-busy - DELETERevoke a subscription link
/api/v1/mailbox/calendar-subscriptions/{token} - GETEvents overlapping a time range
/api/v1/mailbox/calendars/{calendar}/events - POSTCreate an event
/api/v1/mailbox/calendars/{calendar}/events - GETOne event
/api/v1/mailbox/calendars/{calendar}/events/{event_id} - POSTAnswer an invitation
/api/v1/mailbox/calendar/invitations/{invitation_id}/rsvp - PUTReplace an event
/api/v1/mailbox/calendars/{calendar}/events/{event_id} - DELETEDelete an event
/api/v1/mailbox/calendars/{calendar}/events/{event_id}
Mailbox AI
Operations for mailbox ai.
These endpoints take a mailbox token, not an organization API key — they act as one mailbox holder. See Authentication.
Operations
- GETThe mailbox holder's AI consent state
/api/v1/mailbox/ai/consent - GETThe current AI assistant terms
/api/v1/mailbox/ai/terms - POSTLabel a batch of messages
/api/v1/mailbox/ai/classify - POSTDraft or rewrite a message with AI
/api/v1/mailbox/ai/compose - POSTAccept the AI assistant terms
/api/v1/mailbox/ai/consent - DELETEWithdraw AI consent entirely
/api/v1/mailbox/ai/consent - GETThe mailbox holder's consent history
/api/v1/mailbox/ai/consent/history - POSTSummarise a message
/api/v1/mailbox/ai/summarize/{message_id} - DELETEWithdraw the training decision only
/api/v1/mailbox/ai/consent/training - GETDownload one consent document
/api/v1/mailbox/ai/consent/{consent_id}/document - POSTSummarise a whole conversation
/api/v1/mailbox/ai/summarize/thread/{message_id}
Mailbox settings
Operations for mailbox settings.
These endpoints take a mailbox token, not an organization API key — they act as one mailbox holder. See Authentication.
Operations
- GETSenders this mailbox has blocked
/api/v1/mailbox/blocked-senders - GETWhat this deployment's webmail can actually do
/api/v1/mailbox/capabilities - GETMail forwarding settings
/api/v1/mailbox/forwarding - GETThe mailbox's filter rules
/api/v1/mailbox/rules - GETThe mailbox holder's own settings
/api/v1/mailbox/settings - GETThe vacation responder
/api/v1/mailbox/vacation - POSTBlock a sender
/api/v1/mailbox/blocked-senders - PUTUpdate mail forwarding
/api/v1/mailbox/forwarding - PUTReplace the mailbox's filter rules
/api/v1/mailbox/rules - PUTUpdate the mailbox holder's settings
/api/v1/mailbox/settings - PUTUpdate the vacation responder
/api/v1/mailbox/vacation - DELETEUnblock a sender
/api/v1/mailbox/blocked-senders/{address}
Transport rules
Organization-wide rules applied to mail in transit.
Operations
- GETList transport rules
/api/v1/transport-rules - POSTCreate a transport rule
/api/v1/transport-rules - GETRetrieve a transport rule
/api/v1/transport-rules/{id} - PUTUpdate a transport rule
/api/v1/transport-rules/{id} - PUTReorder (transport rule)
/api/v1/transport-rules/reorder - DELETEDelete a transport rule
/api/v1/transport-rules/{id} - PUTEnable a transport rule
/api/v1/transport-rules/{id}/enable
Campaigns
Bulk sends to a list or segment, scheduled and reported on.
Operations
- GETList campaigns
/api/v1/campaigns - POSTCreate a campaign
/api/v1/campaigns - GETRetrieve a campaign
/api/v1/campaigns/{campaign} - PUTUpdate a campaign
/api/v1/campaigns/{campaign} - PATCHUpdate a campaign
/api/v1/campaigns/{campaign} - DELETEDelete a campaign
/api/v1/campaigns/{campaign} - GETRecipients a campaign
/api/v1/campaigns/{campaign}/recipients - GETReport a campaign
/api/v1/campaigns/{campaign}/report - GETStats a campaign
/api/v1/campaigns/{campaign}/stats - POSTCancel a campaign
/api/v1/campaigns/{campaign}/cancel - POSTPause a campaign
/api/v1/campaigns/{campaign}/pause - POSTPreflight a campaign
/api/v1/campaigns/{campaign}/preflight - POSTResend a campaign
/api/v1/campaigns/{campaign}/resend - POSTResume a campaign
/api/v1/campaigns/{campaign}/resume - POSTSchedule a campaign
/api/v1/campaigns/{campaign}/schedule - POSTSend a campaign now
/api/v1/campaigns/{campaign}/send - POSTSend a test
/api/v1/campaigns/{campaign}/test-send
Automations
Journeys that run per contact: triggered by a list, a tag or an event your system records, with waits and emails in between.
Operations
- GETList automations
/api/v1/automations - POSTCreate a automation
/api/v1/automations - GETRetrieve a automation
/api/v1/automations/{automation} - GETNode Types (automation)
/api/v1/automations/node-types - GETRecipes (automation)
/api/v1/automations/recipes - GETSettings (automation)
/api/v1/automations/settings - PUTUpdate a automation
/api/v1/automations/{automation} - PUTSettings (automation)
/api/v1/automations/settings - DELETEDelete a automation
/api/v1/automations/{automation} - GETVersions a automation
/api/v1/automations/{automation}/versions - POSTArchive an automation
/api/v1/automations/{automation}/archive - POSTPreview an automation
/api/v1/automations/{automation}/dry-run - POSTEnrol a automation
/api/v1/automations/{automation}/enrol - POSTPause an automation
/api/v1/automations/{automation}/pause - POSTPublish an automation
/api/v1/automations/{automation}/publish - POSTResume an automation
/api/v1/automations/{automation}/resume
Automation runs
Operations for automation runs.
Automation analytics
Operations for automation analytics.
Automation AI & experiments
Operations for automation ai & experiments.
Operations
- GETExperiments a automation
/api/v1/automations/{automation}/experiments - POSTPropose (automation)
/api/v1/automations/assistant/propose - POSTCreate a automation
/api/v1/automations/{automation}/assistant/email/{node} - POSTPromote a automation
/api/v1/automations/{automation}/experiments/{node}/promote - POSTExplain (automation)
/api/v1/automations/{automation}/runs/{run}/assistant/explain
Contact events
Operations for contact events.
Contacts
Contacts, lists, custom fields and segments.
Operations
- GETList contact tags
/api/v1/contact-tags - GETList contacts
/api/v1/contacts - POSTCreate a contact tag
/api/v1/contact-tags - POSTCreate a contact
/api/v1/contacts - PUTCreate or update a contact
/api/v1/contacts - GETRetrieve a contact
/api/v1/contacts/{contact} - GETAttribute Keys (contact)
/api/v1/contacts/attribute-keys - POSTImport contacts
/api/v1/contacts/import - PUTUpdate a contact
/api/v1/contacts/{contact} - PATCHUpdate a contact
/api/v1/contacts/{contact} - DELETEDelete a contact tag
/api/v1/contact-tags/{tag} - DELETEDelete a contact
/api/v1/contacts/{contact} - GETAutomation Runs a contact
/api/v1/contacts/{contact}/automation-runs - GETList a contact's events
/api/v1/contacts/{contact}/events
Contact lists
Operations for contact lists.
Operations
- GETList contact lists
/api/v1/contact-lists - POSTCreate a contact list
/api/v1/contact-lists - GETRetrieve a contact list
/api/v1/contact-lists/{contact_list} - PUTUpdate a contact list
/api/v1/contact-lists/{contact_list} - PATCHUpdate a contact list
/api/v1/contact-lists/{contact_list} - DELETEDelete a contact list
/api/v1/contact-lists/{contact_list} - POSTAdd contacts to a list
/api/v1/contact-lists/{contactList}/members - DELETERemove a contact from a list
/api/v1/contact-lists/{contactList}/members/{contact}
Contact fields
Operations for contact fields.
Segments
Operations for segments.
Verification
Check whether addresses exist before you send, without sending anything.
Operations
- GETList verifications
/api/v1/verifications - POSTVerify a list of addresses
/api/v1/verifications - GETRetrieve a verification
/api/v1/verifications/{verification} - GETContact health
/api/v1/verifications/summary - POSTCheck one address
/api/v1/verifications/check - POSTVerify your unchecked contacts
/api/v1/verifications/contacts - POSTCount how many addresses look bad (free)
/api/v1/verifications/peek - GETGet a verification's results
/api/v1/verifications/{verification}/results
Domains
Add a sending domain, publish its DNS, and verify it.
Operations
- GETList domains
/api/v1/domains - POSTAdd a domain
/api/v1/domains - GETRetrieve a domain
/api/v1/domains/{domain} - PUTUpdate a domain
/api/v1/domains/{domain} - PATCHUpdate a domain
/api/v1/domains/{domain} - DELETEDelete a domain
/api/v1/domains/{domain} - GETLimits a domain
/api/v1/domains/{domain}/limits - GETOverview a domain
/api/v1/domains/{domain}/overview - POSTDisable a domain
/api/v1/domains/{domain}/disable - POSTEnable a domain
/api/v1/domains/{domain}/enable - POSTRetry Provisioning a domain
/api/v1/domains/{domain}/retry-provisioning - GETRetrieve sending limits for one address
/api/v1/domains/{domain}/limits/{email}
Domain verification
Operations for domain verification.
Operations
- GETDkim a domain
/api/v1/domains/{domain}/dkim - GETDns Provider a domain
/api/v1/domains/{domain}/dns-provider - GETGet the DNS records to publish
/api/v1/domains/{domain}/dns-records - GETVerification Status a domain
/api/v1/domains/{domain}/verification-status - POSTEmail the DNS records to somebody
/api/v1/domains/{domain}/send-records - POSTSync a domain
/api/v1/domains/{domain}/sync - POSTVerify a domain
/api/v1/domains/{domain}/verify
Domain operations
Operations for domain operations.
Domain analytics
Operations for domain analytics.
Senders
Verified identities a message may be sent as.
Operations
- GETList senders
/api/v1/senders - POSTAdd a sending identity
/api/v1/senders - GETRetrieve a sender
/api/v1/senders/{sender} - PUTUpdate a sender
/api/v1/senders/{sender} - PATCHUpdate a sender
/api/v1/senders/{sender} - DELETEDelete a sender
/api/v1/senders/{sender} - GETVerification a sender
/api/v1/senders/{sender}/verification - POSTVerify a sender
/api/v1/senders/{sender}/verify
Account
Organization usage, limits, API keys and dedicated IPs.