API reference

Use the API to verify sending domains, send transactional email and WhatsApp messages, and follow delivery activity.

Base URL#

https://api-connect.nxiom.com/api

Resource paths include the version prefix, for example /v1/emails/send.

Authentication#

Send your API key as a bearer token. Keep it on your server and load it from an environment variable.

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Your API key determines the organization and project. Do not include tenant identifiers in request bodies, query strings, or additional headers.

Domain management and email logs require email.full_access. Sending email requires email.send; a domain-restricted key must allow the sender's domain. Sending and reading messages on the whatsapp channel require whatsapp.send. See API keys.

Start building#

• Create a sending domain and publish its DNS records.
• Verify your domain before sending.
• Send an email with a stable idempotency key.
• Read email logs or subscribe to delivery webhooks.
• Send a message on a messaging channel, such as an approved WhatsApp template from a connected number.

Response conventions#

Successful responses use the shapes documented on each endpoint page. Sending email returns 202 Accepted with a data object; this confirms that the message was queued, not delivered. Sending a WhatsApp message returns 200 OK once WhatsApp has accepted it, which is not yet delivery either.

See Pagination, Usage Limits, and Errors for shared behavior.