Overview
Qboxmail Management API and Send API reference.
Qboxmail provides two API families: the Management API for domains, mailboxes, aliases, migrations, Vault, and Delivery resources, and the Send API for sending email through Qboxmail Delivery. Start with the API concepts for authentication, errors, pagination, and common patterns.
Management API endpoints
List domains
Returns the domains available to the authenticated user.
Create domain
Creates a new domain and its postmaster account.
Get domain
Returns details for a single domain.
Update domain
Updates domain settings, limits, services, address book defaults, and related options.
Update domain status
Enables or disables a domain.
Delete domain
Deletes a domain or queues its deletion when asynchronous cleanup is required.
Check domain DNS records
Queues a DNS check for the domain MX records.
List domain outbound limit options
Returns the outbound sending limit options available for the domain.
List postmasters
Returns postmaster accounts for the domains available to the authenticated user.
List domains without customization
Returns domains that do not have a customization assigned and can receive one.
List domains without manager
Returns domains that are not assigned to a manager.
Verify ownership with DNS
Queues a DNS-based ownership verification for the domain or alias domain.
Verify ownership with DNS synchronously
Checks DNS ownership immediately and queues activation only when the expected A record is already resolvable for the domain or alias domain.
Send ownership verification email
Sends an ownership verification code to one of the allowed domain or alias-domain email addresses.
Verify ownership email code
Verifies the ownership code sent by email and queues domain or alias-domain activation when successful.
Reset email ownership verification
Resets the email ownership verification procedure for the domain or alias domain.
Generate HTML ownership file
Returns the HTML file path to use for domain or alias-domain ownership verification.
Verify ownership with HTML file
Checks the ownership verification HTML file on the domain or alias-domain website and queues activation when valid.
Skip ownership check
Skips the ownership verification step when the authenticated user is allowed to do so.
Generate DKIM record
Generates or returns the DKIM selector and DNS TXT record for the domain.
Verify DKIM record
Validates the domain DKIM DNS TXT record and queues DKIM activation.
Recheck DKIM record
Checks the already verified DKIM DNS TXT record and stores the latest check result.
Enable DKIM
Queues DKIM activation for a disabled DKIM setup.
Disable DKIM without deleting setup
Queues DKIM deactivation while keeping the existing DKIM setup available for later re-enable.
Disable DKIM
Queues DKIM deactivation and removal for the domain.
Reset DKIM setup
Resets the DKIM setup procedure before DNS verification is completed.
Get signature template variables
Returns available domain signature template variables and accounts with missing address book fields.
List accounts without signatures
Returns email accounts in the domain that do not have a configured signature.
List trusted networks
Returns trusted networks configured for the domain. Admin only.
Update trusted networks
Replaces trusted networks configured for the domain. Admin only.
List domain aliases
Returns the alias domains configured for a domain.
Create domain alias
Creates a new alias domain for a domain.
Get domain alias
Returns details for a single domain alias.
Delete domain alias
Deletes a domain alias or queues its deletion when asynchronous cleanup is required.
Verify ownership with DNS
Queues a DNS-based ownership verification for the domain or alias domain.
Verify ownership with DNS synchronously
Checks DNS ownership immediately and queues activation only when the expected A record is already resolvable for the domain or alias domain.
Send ownership verification email
Sends an ownership verification code to one of the allowed domain or alias-domain email addresses.
Verify ownership email code
Verifies the ownership code sent by email and queues domain or alias-domain activation when successful.
Reset email ownership verification
Resets the email ownership verification procedure for the domain or alias domain.
Generate HTML ownership file
Returns the HTML file path to use for domain or alias-domain ownership verification.
Verify ownership with HTML file
Checks the ownership verification HTML file on the domain or alias-domain website and queues activation when valid.
Skip ownership check
Skips the ownership verification step when the authenticated user is allowed to do so.
List email accounts
Returns the email accounts configured for a domain.
Create email account
Creates a new email account on the domain and queues its activation.
Get email account
Returns details for a single email account.
Update email account
Updates email account settings, password, services, forwarding, autoresponder, limits, and address book data.
Update email account status
Enables or disables an email account.
Delete email account
Deletes an email account or queues its deletion when asynchronous cleanup is required.
List email account outbound limit options
Returns the outbound sending limit options available for the email account.
List email aliases
Returns the email aliases configured for a domain.
Create email alias
Creates a new email alias on the domain and queues its activation.
Get email alias
Returns details for a single email alias.
Update email alias
Updates the destinations for an email alias and queues synchronization.
Delete email alias
Deletes an email alias and queues asynchronous cleanup.
List addressbooks
Returns the addressbooks configured for an email account.
Create addressbook
Creates a new addressbook for an email account.
Update addressbook
Updates the name of an addressbook.
Delete addressbook
Deletes an addressbook and its contacts.
List contacts
Returns the contacts in an addressbook.
Create contact
Creates a new contact in an addressbook.
Get contact
Returns details for a single contact in an addressbook.
Update contact
Updates a contact in an addressbook.
Delete contact
Deletes a contact from an addressbook.
List email signatures
Returns the signatures configured for an email account.
Create email signature
Creates a signature for an email account identity.
Get email signature
Returns the signature configured for a specific identity.
Update email signature
Updates the signature configured for an email account identity.
Delete identity signature
Deletes the signature configured for a specific identity.
Delete email signature
Deletes the default signature for an email account.
List Vault domains
Returns domains with Vault archiving enabled or available for the authenticated user.
Activate Vault for domain
Enables Vault archiving for a domain and activates archiving for the selected email accounts.
List Vault email accounts
Returns email accounts with Vault archiving enabled for a domain.
Activate Vault for email accounts
Enables Vault archiving for one or more email accounts in a domain.
Get Vault email account
Returns details for a single email account with Vault archiving enabled.
Update Vault domain settings
Updates default Vault retention and default archive behavior for a domain.
Update Vault domain status
Enables or disables Vault archiving for a domain.
Update Vault email account settings
Updates Vault retention for an email account.
Update Vault email account status
Enables or disables Vault archiving for an email account.
Delete Vault email account
Starts removal of Vault archiving from an email account.
Delete Vault domain
Starts removal of Vault archiving from a domain and its archived email accounts.
List imports
Returns CSV imports for the authenticated user.
Create import
Creates a CSV import for domains, domain aliases, email accounts, or email aliases.
List import resources
Returns the resources parsed from an import CSV file.
Download import CSV file
Downloads the CSV file uploaded for an import. Admin only.
Delete import
Deletes an import and its uploaded CSV file.
Get migration service status
Returns queue and worker status for migration operations.
List migration presets
Returns the migration presets available to the authenticated user.
List migrations
Returns migrations for the authenticated user.
Create migration
Creates a migration from an uploaded CSV file and schedules validation or execution.
Get migration
Returns details for a single migration.
Execute migration now
Forces the first or second migration execution to run now. Admin only.
Get migration stats
Returns aggregate execution statistics for migration runs.
List migration resources
Returns the resources parsed from a migration CSV file.
Get migration resource log
Returns the first or second execution log for a migration resource.
Get migration run
Returns details for a migration run.
Get migration run log
Returns the log for a migration run.
Download migration CSV file
Downloads the CSV file uploaded for a migration. Admin only.
Delete migration
Deletes a migration and cancels its related runs when possible.
List access logs
Returns mailbox access events for a domain or mailbox, including login/logout details and client information.
List incoming mail logs
Returns inbound message trace logs for a domain or mailbox.
List outgoing mail logs
Returns outbound message trace logs for a domain or mailbox.
List managers
Returns the managers available to the authenticated user.
Create manager
Creates a manager and assigns the requested domains and limits.
Get manager
Returns details for a single manager.
Update manager
Updates manager limits, password, assigned domains, and delivery assignments.
Update manager status
Enables or disables a manager.
Preview manager delivery assignment
Returns delivery domains and accounts that would be assigned together with the requested resource.
Assign delivery resources to manager
Assigns a delivery domain or account, including linked resources, to a manager.
Unassign delivery resources from manager
Removes a delivery domain or account, including linked resources, from a manager.
Delete manager
Deletes a manager.
List team members
Returns the team members available to the authenticated user.
Create team member
Creates a team member with the requested permissions.
Get team member
Returns details for a single team member.
Update team member
Updates a team member password and permissions.
Update team member status
Enables or disables a team member.
Delete team member
Deletes a team member.
Get Delivery prices
Returns Delivery product prices grouped by account type and billing cycle.
Get Delivery pricing page
Returns pricing page data for Delivery products for the current customer context.
List Delivery domains
Returns Delivery domains available to the authenticated user.
Create Delivery domain
Creates a Delivery domain for the current customer context.
Get Delivery domain
Returns a Delivery domain by code.
Verify Delivery domain
Validates DNS configuration for a Delivery domain.
Update Delivery domain status
Enables or disables a Delivery domain.
Delete Delivery domain
Deletes a Delivery domain.
List Delivery accounts
Returns Delivery accounts available to the authenticated user.
Create Delivery account
Creates a Delivery account and optionally creates the customer billing profile/order.
Get Delivery account
Returns a Delivery account by id.
Update Delivery account
Updates Delivery account settings, plan, assigned domains, notifications, suppression behavior and trusted networks.
Update Delivery account status
Enables or disables a Delivery account.
Reset Delivery account password
Generates new SMTP credentials for a Delivery account.
List Delivery API tokens
Returns API tokens configured for a Delivery account.
Create Delivery API token
Creates an API token for a Delivery account. The plain token is returned only once.
Update Delivery API token
Updates allow-listed networks for a Delivery API token.
Delete Delivery API token
Deletes a Delivery API token.
Delete Delivery account
Deletes a Delivery account or schedules deletion at the end of the billing cycle.
List suppression list entries
Returns suppression list entries for the current customer context.
Get suppression list entry
Returns suppression list details for an email address.
Create suppression list entry
Adds a manual suppression list entry.
Update suppression list entry
Updates reason, account restrictions or active state for a suppression list entry.
Delete suppression list entry
Removes a suppression list entry by email address.
Export suppression list
Generates a CSV export for suppression list entries.
Import suppression list
Imports suppression list entries from CSV content.
List Delivery dashboard alerts
Returns dashboard alert resources for a Delivery alert code and severity.
Get TraceMail dashboard
Returns dashboard metrics, top accounts and alert groups for TraceMail.
Get TraceMail counters
Returns aggregate TraceMail counters for the selected filters.
List TraceMail accounts
Returns Delivery account options available in TraceMail filters.
List TraceMail domains
Returns Delivery domain options available in TraceMail filters.
List TraceMail mailouts
Returns TraceMail log entries filtered by account, domain, dates, addresses, subject, collection, status or error category.
Get TraceMail daily statistics
Returns daily TraceMail statistics for a Delivery account.
Get TraceMail domain ranking
Returns TraceMail statistics grouped by domain for a Delivery account.
Delete export
Deletes an export job and its generated file when present.
Update notification settings
Configure account-level webhook and email notifications for the authenticated customer or manager. This applies to all mailboxes managed by that user. It does not disable the quota warning emails sent directly to mailbox users. Behavior: - Omitted fields keep their current value. - Boolean action fields enable or disable only that action. - Destination fields (`notification_url`, `notification_email`) may remain saved when all actions are disabled, so they can be reused later.