API reference
API Reference
Every endpoint across the email (v1) and the all-channel (v2) APIs. Same Authorization: Bearer $API_KEY on both. Machine-readable:
v1 OpenAPI JSON ·
v2 OpenAPI JSON.
v1 — Email
https://theaurapost.com/api/v1
API Keys 3 endpoints
GET
/api-keysList this tenant's API keys
POST
/api-keys/generateGenerate a new API key
DELETE
/api-keys/{id}/revokeRevoke an API key
Campaigns 4 endpoints
GET
/campaignsList campaigns
POST
/campaignsCreate a campaign
GET
/campaigns/{id}/estimatePre-send cost estimate + live balance
POST
/campaigns/{id}/sendSend a campaign (truthful status)
Embedded Designer 2 endpoints
POST
/embed/designer/tokenMint an embedded designer token (master key)
GET
/embed/designer/contextEmbedded designer bootstrap context
GDPR 6 endpoints
POST
/gdpr/exportRequest a data export for a contact
POST
/gdpr/deletionRequest deletion of a contact's data
GET
/gdpr/requestsList data export/deletion requests
GET
/gdpr/requests/{id}Check a data request's status
GET
/gdpr/retention-policyGet this tenant's data retention settings
PUT
/gdpr/retention-policyUpdate data retention settings
Health 1 endpoint
GET
/health/lanesPer-channel, per-lane queue depth
Reseller 4 endpoints
GET
/partners/sub-accountsList merchants
POST
/partners/sub-accountsCreate a merchant
PUT
/partners/sub-accounts/{id}Update a merchant (identity, limits, and the prices it pays)
POST
/partners/sub-accounts/{id}/fundFund a merchant wallet
Sending 3 endpoints
POST
/messages/sendSend a single transactional email
POST
/messages/batchSend a batch (<=50 recipients)
GET
/messages/{id}/statusMessage delivery status
Templates 4 endpoints
GET
/templatesList templates
POST
/templatesCreate a template
GET
/templates/{id}Get a template
PUT
/templates/{id}Update / save-back a template (API key or embed token)
Webhooks 3 endpoints
GET
/webhooksGet this tenant's webhook configuration
PUT
/webhooksConfigure the webhook URL, mode, signing secret, and subscribed events
GET
/webhooks/deliveriesRecent webhook delivery attempts
v2 — WhatsApp, Push & OTP, SMS, RCS, fallback chains, partners
https://theaurapost.com/api/v2
Email 2 endpoints
POST
/messages/email/sendSend one email (asynchronous — 202 queued, poll status or use webhooks)
GET
/messages/email/status/{external_id}Status of an asynchronously sent email (by external_id)
Message classes 1 endpoint
POST
/messages/sendSend by message class (the template is chosen for you)
Push 4 endpoints
POST
/push/sendSend a single transactional push notification
GET
/push/analyticsPush funnel analytics (views, clicks, conversions)
GET
/activity/pushPer-notification push activity feed
GET
/activity/push/summaryPush activity summary
Push Campaigns 4 endpoints
GET
/push/campaignsList push campaigns
POST
/push/campaignsCreate a push campaign
POST
/push/campaigns/{id}/sendSend a push campaign
GET
/push/campaigns/{id}/reportPush campaign delivery report
Push Templates 2 endpoints
GET
/push/templatesList push templates
POST
/push/templatesCreate a push template
RCS 3 endpoints
POST
/messages/rcs/sendSend a single RCS message (registered RCS template required)
POST
/messages/rcs/batchSend RCS to up to 50 recipients (one registration)
GET
/messages/rcs/{id}/statusRCS delivery status
Relay campaigns 4 endpoints
POST
/messages/email/batchRelay mode only: send up to 50 finished emails in one call
GET
/campaigns/relayList your Relay campaigns
GET
/campaigns/relay/{ref}One Relay campaign: status and running totals (accepted, refused, delivered, read, failed, in_flight)
POST
/campaigns/relay/{ref}/closeSay you have sent everything: the campaign completes once every accepted message has an outcome (or after the settle period), and campaign.completed is sent once
SMS 7 endpoints
POST
/messages/sms/sendSend a single SMS (registered DLT template required)
POST
/messages/sms/batchSend an SMS to up to 50 recipients (one registration)
GET
/messages/sms/{id}/statusSMS delivery status
POST
/sms/otp/sendSend an SMS OTP
POST
/sms/consent/confirmRecord SMS consent (promotional / service-explicit) for one or many phones
POST
/sms/consent/revokeRevoke SMS consent for one or many phones
GET
/sms/consentCurrent SMS consent state for one phone
Units 2 endpoints
GET
/partners/units/balanceYour own prepaid unit packages (units left per channel)
GET
/partners/account-positionYour wallet, credit line and merchant counts
Usage 8 endpoints
GET
/partners/whatsapp/usage/{period}Reseller WhatsApp usage for a month, with your margin
GET
/partners/whatsapp/usage/{period}/export-csvSame as /partners/whatsapp/usage/{period}, as CSV
GET
/partners/push/usage/{period}Reseller Push usage for a month, with your margin
GET
/partners/push/usage/{period}/export-csvSame as /partners/push/usage/{period}, as CSV
GET
/partners/sms/usage/{period}Reseller SMS usage for a month, with your margin
GET
/partners/sms/usage/{period}/export-csvSame as /partners/sms/usage/{period}, as CSV
GET
/partners/rcs/usage/{period}Reseller RCS usage for a month, with your margin
GET
/partners/rcs/usage/{period}/export-csvSame as /partners/rcs/usage/{period}, as CSV
WhatsApp 8 endpoints
POST
/messages/whatsapp/sendSend a single WhatsApp message (approved template required)
POST
/messages/whatsapp/batchSend WhatsApp to multiple recipients
GET
/messages/whatsapp/{id}/statusWhatsApp message delivery status
POST
/messages/whatsapp/{id}/retryRetry a failed WhatsApp message
POST
/whatsapp/otp/sendSend a WhatsApp OTP
GET
/activity/whatsappPer-message WhatsApp activity feed
GET
/activity/whatsapp/summaryWhatsApp activity summary (rates, category breakdown)
POST
/whatsapp/consent/confirmConfirm WhatsApp consent your own system already captured
WhatsApp Campaigns 6 endpoints
GET
/campaigns/whatsappList WhatsApp campaigns
POST
/campaigns/whatsappCreate a WhatsApp campaign
POST
/campaigns/whatsapp/{id}/recipients/batchAppend recipients to a campaign (ingest, before seal)
POST
/campaigns/whatsapp/{id}/sealSeal a campaign's recipient list (no more appends after this)
POST
/campaigns/whatsapp/{id}/sendSend a sealed WhatsApp campaign
GET
/campaigns/whatsapp/{id}/reportWhatsApp campaign delivery report, incl. failure-category breakdown
WhatsApp Templates 4 endpoints
GET
/whatsapp/templatesList WhatsApp templates
POST
/whatsapp/templatesCreate a WhatsApp template draft
POST
/whatsapp/templates/{id}/publishSubmit a template to Meta for review
POST
/whatsapp/templates/{id}/deployDeploy an approved template to a connection