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-keys
List this tenant's API keys
POST
/api-keys/generate
Generate a new API key
DELETE
/api-keys/{id}/revoke
Revoke an API key
Campaigns 4 endpoints
GET
/campaigns
List campaigns
POST
/campaigns
Create a campaign
GET
/campaigns/{id}/estimate
Pre-send cost estimate + live balance
POST
/campaigns/{id}/send
Send a campaign (truthful status)
Embedded Designer 2 endpoints
POST
/embed/designer/token
Mint an embedded designer token (master key)
GET
/embed/designer/context
Embedded designer bootstrap context
GDPR 6 endpoints
POST
/gdpr/export
Request a data export for a contact
POST
/gdpr/deletion
Request deletion of a contact's data
GET
/gdpr/requests
List data export/deletion requests
GET
/gdpr/requests/{id}
Check a data request's status
GET
/gdpr/retention-policy
Get this tenant's data retention settings
PUT
/gdpr/retention-policy
Update data retention settings
Health 1 endpoint
GET
/health/lanes
Per-channel, per-lane queue depth
Reseller 4 endpoints
GET
/partners/sub-accounts
List merchants
POST
/partners/sub-accounts
Create a merchant
PUT
/partners/sub-accounts/{id}
Update a merchant (identity, limits, and the prices it pays)
POST
/partners/sub-accounts/{id}/fund
Fund a merchant wallet
Sending 3 endpoints
POST
/messages/send
Send a single transactional email
POST
/messages/batch
Send a batch (<=50 recipients)
GET
/messages/{id}/status
Message delivery status
Templates 4 endpoints
GET
/templates
List templates
POST
/templates
Create 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
/webhooks
Get this tenant's webhook configuration
PUT
/webhooks
Configure the webhook URL, mode, signing secret, and subscribed events
GET
/webhooks/deliveries
Recent webhook delivery attempts

v2 — WhatsApp, Push & OTP, SMS, RCS, fallback chains, partners

https://theaurapost.com/api/v2

Email 2 endpoints
POST
/messages/email/send
Send 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/send
Send by message class (the template is chosen for you)
Push 4 endpoints
POST
/push/send
Send a single transactional push notification
GET
/push/analytics
Push funnel analytics (views, clicks, conversions)
GET
/activity/push
Per-notification push activity feed
GET
/activity/push/summary
Push activity summary
Push Campaigns 4 endpoints
GET
/push/campaigns
List push campaigns
POST
/push/campaigns
Create a push campaign
POST
/push/campaigns/{id}/send
Send a push campaign
GET
/push/campaigns/{id}/report
Push campaign delivery report
Push Templates 2 endpoints
GET
/push/templates
List push templates
POST
/push/templates
Create a push template
RCS 3 endpoints
POST
/messages/rcs/send
Send a single RCS message (registered RCS template required)
POST
/messages/rcs/batch
Send RCS to up to 50 recipients (one registration)
GET
/messages/rcs/{id}/status
RCS delivery status
Relay campaigns 4 endpoints
POST
/messages/email/batch
Relay mode only: send up to 50 finished emails in one call
GET
/campaigns/relay
List 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}/close
Say 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/send
Send a single SMS (registered DLT template required)
POST
/messages/sms/batch
Send an SMS to up to 50 recipients (one registration)
GET
/messages/sms/{id}/status
SMS delivery status
POST
/sms/otp/send
Send an SMS OTP
POST
/sms/consent/confirm
Record SMS consent (promotional / service-explicit) for one or many phones
POST
/sms/consent/revoke
Revoke SMS consent for one or many phones
GET
/sms/consent
Current SMS consent state for one phone
Units 2 endpoints
GET
/partners/units/balance
Your own prepaid unit packages (units left per channel)
GET
/partners/account-position
Your 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-csv
Same 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-csv
Same 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-csv
Same 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-csv
Same as /partners/rcs/usage/{period}, as CSV
WhatsApp 8 endpoints
POST
/messages/whatsapp/send
Send a single WhatsApp message (approved template required)
POST
/messages/whatsapp/batch
Send WhatsApp to multiple recipients
GET
/messages/whatsapp/{id}/status
WhatsApp message delivery status
POST
/messages/whatsapp/{id}/retry
Retry a failed WhatsApp message
POST
/whatsapp/otp/send
Send a WhatsApp OTP
GET
/activity/whatsapp
Per-message WhatsApp activity feed
GET
/activity/whatsapp/summary
WhatsApp activity summary (rates, category breakdown)
POST
/whatsapp/consent/confirm
Confirm WhatsApp consent your own system already captured
WhatsApp Campaigns 6 endpoints
GET
/campaigns/whatsapp
List WhatsApp campaigns
POST
/campaigns/whatsapp
Create a WhatsApp campaign
POST
/campaigns/whatsapp/{id}/recipients/batch
Append recipients to a campaign (ingest, before seal)
POST
/campaigns/whatsapp/{id}/seal
Seal a campaign's recipient list (no more appends after this)
POST
/campaigns/whatsapp/{id}/send
Send a sealed WhatsApp campaign
GET
/campaigns/whatsapp/{id}/report
WhatsApp campaign delivery report, incl. failure-category breakdown
WhatsApp Templates 4 endpoints
GET
/whatsapp/templates
List WhatsApp templates
POST
/whatsapp/templates
Create a WhatsApp template draft
POST
/whatsapp/templates/{id}/publish
Submit a template to Meta for review
POST
/whatsapp/templates/{id}/deploy
Deploy an approved template to a connection