Base URL
Authentication
All API endpoints are authenticated using API keys. Create an API key from the Sendrealm dashboard, then include it in theAuthorization header for each request.
Resources
Emails
Send transactional or product emails through the API.
Push notifications
Send notifications to push devices, contacts, external IDs, or audiences.
Audiences
Create, list, update, and delete audiences.
Audience properties
Define custom fields for contact and audience data.
Contacts
Create, list, update, and delete contacts.
Audience memberships
Add contacts to audiences or remove them.
Events
Ingest customer events and react to Sendrealm system events.
Templates
Create, publish, restore, and reuse email or push templates.
Automations
Create automation drafts, publish them, and inspect their runs.
Topics
Manage reusable topic subscriptions for audience preferences.
Status codes
The Sendrealm API uses HTTP status codes to indicate the result of each request.| Status Code | Description |
|---|---|
| 200 | Successful request. |
| 201 | Resource created or notification sent. |
| 400 | Invalid request parameters. |
| 401 | API key was missing or invalid. |
| 404 | Resource was not found. |
| 409 | Resource conflict. |
| 422 | Request could not be processed. |
Automation platform guarantees
- Event ingest and automation execution use at-least-once delivery semantics.
- Reuse
idempotency_keyonPOST /eventswhenever your source system can retry. - Wait timeouts are scheduler-based and should be treated as approximate, not millisecond exact.
- Event ordering is best effort and should not be treated as a strict serial log.
- Retention windows for events, runs, and waits are controlled at the project policy level.
- Plan limits and metered usage may apply to event ingest, automation runs, waits, template tests, and send actions.