API Reference
Programmatic access to your MailRoute account: user provisioning, policy management, and reporting.
12 articles
Provision a Domain and Its Users with the API
FeaturedCreate a domain on the right plan, add users with passwords, and verify the result — the complete provisioning sequence with working curl examples.
What Is MailRoute's API?
FeaturedMailRoute's REST API automates provisioning, allow and block lists, quarantine and forwarding. Included on Enterprise plans — what it covers and what it costs.
Bulk-Import Users with the MailRoute API
FeaturedAdd up to 500 users in a single call, attach aliases, and remove users in bulk — the endpoints that make a migration practical, with working examples.
Manage Allow and Block Lists with the MailRoute API
FeaturedAllow or block senders for one mailbox or a whole domain, add entries in bulk, and list what is already set — with working curl examples for each.
List and Release Quarantined Mail with the API
FeaturedFind what is in quarantine for a mailbox or domain, release a message, and allow the sender at the same time — with the query parameter that decides everything.
Count Your Billable Users with the API
Tell real mailboxes apart from auto-added accounts, distribution lists and aliases, and get an exact live user count per domain or across an account.
List a Domain's Users and Aliases with the API
A Python script that lists every address on a domain: mailboxes, auto-added accounts and distribution lists, whether each is billed, and its aliases.
MailRoute API: Authentication and Conventions
Authenticate to the MailRoute API, understand resource URIs, pagination, filtering and error responses, and know which API version to use.
Quarantine API Reference
Reference for the MailRoute v2 Quarantine API: list, delete, recover quarantined messages, and manage allow lists for domains and email accounts.
Set an Out-of-Office Reply with the API
Turn a Hosted Mail mailbox's autoresponder on or off, set its subject and body, and control how often the same sender hears back — one call each.
Set or Reset a User's Password with the API
Change an existing MailRoute user's password, or set one on an account created without credentials, using the field the API schema does not list.
Tune Filtering for a Domain or a Mailbox with the API
Read and adjust anti-spam, anti-virus, banned-file, bad-header and size policy per domain or per mailbox, and detach one mailbox from the domain's policy.