Skip to main content
The Sendrealm API lets you send emails and push notifications, manage contacts, organize your contacts with audiences and topics, store versioned templates, run event-driven automations, and build campaign drafts.

​
Base URL

​
Authentication

All API endpoints are authenticated using API keys. Create an API key from the Sendrealm dashboard, then include it in the Authorization header for each request.
Project API keys are permanently limited to their owning project. Team API keys can be limited to selected projects, and every key can be limited by permission. For a team key that can access multiple projects, requests use its default project unless you provide an authorized project explicitly:
An invalid API key returns 401. A valid key without access to the selected project or action returns 403.

​
Resources

Emails

Send transactional or product emails through the API.

Push notifications

Send notifications to push devices, contacts, external IDs, or audiences.

Push integration testing

Inspect apps and devices, send one-device tests, and trace delivery events.

Project

Confirm the project and capabilities assigned to an API key.

Domains

Inspect sending domains, DNS records, verification state, and tracking settings.

Campaigns

Create and edit email campaign drafts for dashboard review.

Push campaigns

Create, preview, and test push campaign drafts without launching them.

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.

​
Automation platform guarantees

  • Event ingest and automation execution use at-least-once delivery semantics.
  • Reuse idempotency_key on POST /events whenever 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.