API Concepts
Start here to understand Qboxmail APIs before reading the endpoint reference.
Qboxmail has two APIs: the Management API creates and manages Hosting and Delivery resources, while the Send API sends transactional and newsletter email from an existing Delivery account.
Use the Management API to create and configure resources, including Delivery domains and Delivery accounts. Use the Send API only when the Delivery account is ready and you want to send email.
Choose the right API
See which API to use for each task.
Authentication
Management API tokens, Send API bearer tokens, and Delivery account tokens.
Sandbox environment
Test API workflows safely before using production resources.
Management API fundamentals
Manage Hosting domains, mailboxes, Delivery accounts, suppression lists, and logs.
Set up Delivery before sending
Prepare domains, accounts, DNS, and API tokens before calling the Send API.
Send API fundamentals
Send single, batch, and bulk messages from an existing Delivery account.
Common workflows
Practical examples that combine Management API and Send API calls.
Responses and pagination
Understand response formats, pagination, and send responses.
Errors and retries
Understand validation errors, request IDs, rate limits, and retry strategy.
Limits, quotas, and suppression
Throughput limits, quota reservation, and suppression-list behavior.
Logs and troubleshooting
Use TraceMail, Email log analysis, counters, and IDs to debug delivery issues.