# WazobiaMail

> Custom-domain inboxes, business email and sending API guides for WazobiaMail.

- [WazobiaMail API documentation](https://docs.wazobiamail.com/docs/index.md): Custom-domain inboxes and sending APIs for individuals, teams and developers.
- [Quickstart](https://docs.wazobiamail.com/docs/guides/quickstart.md): Send your first email with the WazobiaMail API in five minutes.
- [Authentication](https://docs.wazobiamail.com/docs/guides/authentication.md): Sessions, tokens, API keys and scopes for the WazobiaMail API.
- [Integration examples](https://docs.wazobiamail.com/docs/guides/integrations.md): Send from JavaScript, TypeScript, PHP, Go, Rust or Python.
- [API overview](https://docs.wazobiamail.com/docs/api-reference.md): Explore the interactive API reference and download the OpenAPI specification.
- [API keys](https://docs.wazobiamail.com/docs/guides/api-keys.md): App keys for management endpoints and sending keys for the send endpoints.
- [Sending email](https://docs.wazobiamail.com/docs/guides/sending.md): Send transactional email with the messages endpoint.
- [Sending domains](https://docs.wazobiamail.com/docs/guides/domains.md): Add, verify and manage the domains you send from.
- [Hosted mailboxes](https://docs.wazobiamail.com/docs/guides/mailboxes.md): Create inboxes that can receive mail and issue SMTP/IMAP credentials.
- [Attachments](https://docs.wazobiamail.com/docs/guides/attachments.md): Send a message and files together using multipart form data.
- [Open and click tracking](https://docs.wazobiamail.com/docs/guides/tracking.md): Follow engagement on paid plans.
- [Billing](https://docs.wazobiamail.com/docs/guides/billing.md): Plans, subscriptions, invoices, payments and email credits.
- [Account management](https://docs.wazobiamail.com/docs/guides/account.md): Profile, password, two-factor, sessions, notifications and usage.
- [Support](https://docs.wazobiamail.com/docs/guides/support.md): Open and follow support tickets.
- [Webhooks](https://docs.wazobiamail.com/docs/guides/webhooks.md): Payment provider callbacks and signature verification.
- [Errors and limits](https://docs.wazobiamail.com/docs/guides/errors.md): Response envelope, status codes, validation and rate limits.
- [Create an account](https://docs.wazobiamail.com/docs/api-reference/auth/create-an-account.md)
- [Sign in with email and password](https://docs.wazobiamail.com/docs/api-reference/auth/sign-in-with-email-and-password.md)
- [Exchange a refresh token for new tokens](https://docs.wazobiamail.com/docs/api-reference/auth/exchange-a-refresh-token-for-new-tokens.md)
- [Revoke a refresh token](https://docs.wazobiamail.com/docs/api-reference/auth/revoke-a-refresh-token.md)
- [Read the current account](https://docs.wazobiamail.com/docs/api-reference/auth/read-the-current-account.md)
- [Email a one-time sign-in code](https://docs.wazobiamail.com/docs/api-reference/auth/email-a-one-time-sign-in-code.md)
- [Sign in with a one-time code](https://docs.wazobiamail.com/docs/api-reference/auth/sign-in-with-a-one-time-code.md)
- [Email a sign-in link](https://docs.wazobiamail.com/docs/api-reference/auth/email-a-sign-in-link.md)
- [Sign in from a magic link](https://docs.wazobiamail.com/docs/api-reference/auth/sign-in-from-a-magic-link.md)
- [Request a password-reset code](https://docs.wazobiamail.com/docs/api-reference/auth/request-a-password-reset-code.md)
- [Reset the password with a code](https://docs.wazobiamail.com/docs/api-reference/auth/reset-the-password-with-a-code.md)
- [Start Google sign-in (redirect)](https://docs.wazobiamail.com/docs/api-reference/auth/start-google-sign-in-redirect.md)
- [Start GitHub sign-in (redirect)](https://docs.wazobiamail.com/docs/api-reference/auth/start-github-sign-in-redirect.md)
- [Exchange an OAuth code for tokens](https://docs.wazobiamail.com/docs/api-reference/auth/exchange-an-oauth-code-for-tokens.md)
- [List active sessions](https://docs.wazobiamail.com/docs/api-reference/auth/list-active-sessions.md)
- [Revoke one session](https://docs.wazobiamail.com/docs/api-reference/auth/revoke-one-session.md)
- [Revoke every other session](https://docs.wazobiamail.com/docs/api-reference/auth/revoke-every-other-session.md)
- [List app API keys](https://docs.wazobiamail.com/docs/api-reference/auth/list-app-api-keys.md): App keys authenticate management endpoints with scoped permissions. Sending keys are separate: see Sending.
- [Create an app API key](https://docs.wazobiamail.com/docs/api-reference/auth/create-an-app-api-key.md)
- [Rotate an app API key](https://docs.wazobiamail.com/docs/api-reference/auth/rotate-an-app-api-key.md)
- [Revoke an app API key](https://docs.wazobiamail.com/docs/api-reference/auth/revoke-an-app-api-key.md)
- [Read the account profile](https://docs.wazobiamail.com/docs/api-reference/account/read-the-account-profile.md)
- [Update the account profile](https://docs.wazobiamail.com/docs/api-reference/account/update-the-account-profile.md)
- [Change the password](https://docs.wazobiamail.com/docs/api-reference/account/change-the-password.md)
- [Toggle code-based login](https://docs.wazobiamail.com/docs/api-reference/account/toggle-code-based-login.md)
- [Start authenticator setup](https://docs.wazobiamail.com/docs/api-reference/account/start-authenticator-setup.md)
- [Confirm authenticator setup](https://docs.wazobiamail.com/docs/api-reference/account/confirm-authenticator-setup.md)
- [Turn off two-factor auth](https://docs.wazobiamail.com/docs/api-reference/account/turn-off-two-factor-auth.md)
- [Delete the account](https://docs.wazobiamail.com/docs/api-reference/account/delete-the-account.md)
- [Read onboarding state](https://docs.wazobiamail.com/docs/api-reference/account/read-onboarding-state.md)
- [List account activity](https://docs.wazobiamail.com/docs/api-reference/account/list-account-activity.md)
- [Update security preferences](https://docs.wazobiamail.com/docs/api-reference/account/update-security-preferences.md)
- [List notifications](https://docs.wazobiamail.com/docs/api-reference/account/list-notifications.md)
- [Mark one notification read](https://docs.wazobiamail.com/docs/api-reference/account/mark-one-notification-read.md)
- [Mark all notifications read](https://docs.wazobiamail.com/docs/api-reference/account/mark-all-notifications-read.md)
- [Delete a notification](https://docs.wazobiamail.com/docs/api-reference/account/delete-a-notification.md)
- [Count unread notifications](https://docs.wazobiamail.com/docs/api-reference/account/count-unread-notifications.md)
- [Read notification preferences](https://docs.wazobiamail.com/docs/api-reference/account/read-notification-preferences.md)
- [Update notification preferences](https://docs.wazobiamail.com/docs/api-reference/account/update-notification-preferences.md)
- [Send an email](https://docs.wazobiamail.com/docs/api-reference/sending/send-an-email.md)
- [Upload an attachment](https://docs.wazobiamail.com/docs/api-reference/sending/upload-an-attachment.md)
- [Send an email with attachments](https://docs.wazobiamail.com/docs/api-reference/sending/send-an-email-with-attachments.md)
- [List tracked messages with opens and clicks](https://docs.wazobiamail.com/docs/api-reference/sending/list-tracked-messages-with-opens-and-clicks.md)
- [Open-tracking pixel](https://docs.wazobiamail.com/docs/api-reference/sending/open-tracking-pixel.md): Fetched by email clients from the pixel URL in your HTML. Do not call directly.
- [Click-tracking redirect](https://docs.wazobiamail.com/docs/api-reference/sending/click-tracking-redirect.md): Fetched by recipients from rewritten links. Do not call directly.
- [List sending domains](https://docs.wazobiamail.com/docs/api-reference/sending/list-sending-domains.md)
- [Add a sending domain](https://docs.wazobiamail.com/docs/api-reference/sending/add-a-sending-domain.md)
- [Read a sending domain](https://docs.wazobiamail.com/docs/api-reference/sending/read-a-sending-domain.md)
- [Rename a sending domain](https://docs.wazobiamail.com/docs/api-reference/sending/rename-a-sending-domain.md)
- [Remove a sending domain](https://docs.wazobiamail.com/docs/api-reference/sending/remove-a-sending-domain.md)
- [Read required DNS records](https://docs.wazobiamail.com/docs/api-reference/sending/read-required-dns-records.md)
- [Verify domain DNS](https://docs.wazobiamail.com/docs/api-reference/sending/verify-domain-dns.md)
- [Read the DNS provider setup](https://docs.wazobiamail.com/docs/api-reference/sending/read-the-dns-provider-setup.md)
- [Start Cloudflare DNS connect](https://docs.wazobiamail.com/docs/api-reference/sending/start-cloudflare-dns-connect.md)
- [Finish Cloudflare DNS connect](https://docs.wazobiamail.com/docs/api-reference/sending/finish-cloudflare-dns-connect.md): Redirect target for the Cloudflare OAuth callback.
- [Read Cloudflare connection status](https://docs.wazobiamail.com/docs/api-reference/sending/read-cloudflare-connection-status.md)
- [Sync DNS records to Cloudflare](https://docs.wazobiamail.com/docs/api-reference/sending/sync-dns-records-to-cloudflare.md)
- [Disconnect Cloudflare DNS](https://docs.wazobiamail.com/docs/api-reference/sending/disconnect-cloudflare-dns.md)
- [List sending API keys](https://docs.wazobiamail.com/docs/api-reference/sending/list-sending-api-keys.md): Sending keys authenticate the send endpoints via X-API-Key. They are separate from app keys.
- [Create a sending API key](https://docs.wazobiamail.com/docs/api-reference/sending/create-a-sending-api-key.md)
- [Revoke a sending API key](https://docs.wazobiamail.com/docs/api-reference/sending/revoke-a-sending-api-key.md)
- [Rotate a sending API key](https://docs.wazobiamail.com/docs/api-reference/sending/rotate-a-sending-api-key.md)
- [Read SMTP access state](https://docs.wazobiamail.com/docs/api-reference/sending/read-smtp-access-state.md)
- [Enable or rotate SMTP access](https://docs.wazobiamail.com/docs/api-reference/sending/enable-or-rotate-smtp-access.md)
- [List hosted mailboxes](https://docs.wazobiamail.com/docs/api-reference/mailboxes/list-hosted-mailboxes.md)
- [Create a hosted mailbox](https://docs.wazobiamail.com/docs/api-reference/mailboxes/create-a-hosted-mailbox.md)
- [Read a hosted mailbox](https://docs.wazobiamail.com/docs/api-reference/mailboxes/read-a-hosted-mailbox.md)
- [Delete a hosted mailbox](https://docs.wazobiamail.com/docs/api-reference/mailboxes/delete-a-hosted-mailbox.md)
- [Issue mailbox SMTP/IMAP credentials](https://docs.wazobiamail.com/docs/api-reference/mailboxes/issue-mailbox-smtpimap-credentials.md)
- [Rotate mailbox credentials](https://docs.wazobiamail.com/docs/api-reference/mailboxes/rotate-mailbox-credentials.md)
- [Read mailbox storage usage](https://docs.wazobiamail.com/docs/api-reference/mailboxes/read-mailbox-storage-usage.md)
- [List SMTP relays](https://docs.wazobiamail.com/docs/api-reference/relays/list-smtp-relays.md)
- [Add an SMTP relay](https://docs.wazobiamail.com/docs/api-reference/relays/add-an-smtp-relay.md)
- [Read an SMTP relay](https://docs.wazobiamail.com/docs/api-reference/relays/read-an-smtp-relay.md)
- [Remove an SMTP relay](https://docs.wazobiamail.com/docs/api-reference/relays/remove-an-smtp-relay.md)
- [Update an SMTP relay](https://docs.wazobiamail.com/docs/api-reference/relays/update-an-smtp-relay.md)
- [List subscription plans](https://docs.wazobiamail.com/docs/api-reference/billing/list-subscription-plans.md)
- [Read your effective limits](https://docs.wazobiamail.com/docs/api-reference/billing/read-your-effective-limits.md)
- [Read the current subscription](https://docs.wazobiamail.com/docs/api-reference/billing/read-the-current-subscription.md)
- [Start a subscription checkout](https://docs.wazobiamail.com/docs/api-reference/billing/start-a-subscription-checkout.md)
- [Activate after payment](https://docs.wazobiamail.com/docs/api-reference/billing/activate-after-payment.md)
- [Toggle renewal](https://docs.wazobiamail.com/docs/api-reference/billing/toggle-renewal.md)
- [Cancel at term end](https://docs.wazobiamail.com/docs/api-reference/billing/cancel-at-term-end.md)
- [List invoices](https://docs.wazobiamail.com/docs/api-reference/billing/list-invoices.md)
- [Read one invoice](https://docs.wazobiamail.com/docs/api-reference/billing/read-one-invoice.md)
- [Start a payment](https://docs.wazobiamail.com/docs/api-reference/billing/start-a-payment.md)
- [Confirm a payment by reference](https://docs.wazobiamail.com/docs/api-reference/billing/confirm-a-payment-by-reference.md)
- [List enabled payment methods](https://docs.wazobiamail.com/docs/api-reference/billing/list-enabled-payment-methods.md)
- [Detect billing currency](https://docs.wazobiamail.com/docs/api-reference/billing/detect-billing-currency.md): Reads the edge country header (NG becomes NGN, anything else USD) with an explicit currency override.
- [Read credit balance](https://docs.wazobiamail.com/docs/api-reference/billing/read-credit-balance.md)
- [List credit packs](https://docs.wazobiamail.com/docs/api-reference/billing/list-credit-packs.md)
- [Buy email credits](https://docs.wazobiamail.com/docs/api-reference/billing/buy-email-credits.md)
- [Read the credit ledger](https://docs.wazobiamail.com/docs/api-reference/billing/read-the-credit-ledger.md)
- [Provider payment callback](https://docs.wazobiamail.com/docs/api-reference/billing/provider-payment-callback.md): Called by the payment provider, never by integrators. Deliveries are signature-verified and idempotent; configure the provider dashboard with this URL.
- [Open a support ticket](https://docs.wazobiamail.com/docs/api-reference/support/open-a-support-ticket.md)
- [List your support tickets](https://docs.wazobiamail.com/docs/api-reference/support/list-your-support-tickets.md)
- [Account usage overview](https://docs.wazobiamail.com/docs/api-reference/dashboard/account-usage-overview.md)
- [Onboarding checklist state](https://docs.wazobiamail.com/docs/api-reference/dashboard/onboarding-checklist-state.md)

## OpenAPI Specs

- [customer-openapi](/docs/customer-openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.