# Sendrealm Documentation

## Docs

- [Introduction](https://docs.sendrealm.com/introduction.md): Welcome to the Sendrealm documentation
- [Domains](https://docs.sendrealm.com/tutorials/domains.md): How to use custom domains to send emails
- [API Keys](https://docs.sendrealm.com/tutorials/api-keys.md): Create and manage team-wide and project-scoped API keys
- [SMTP](https://docs.sendrealm.com/tutorials/smtp.md): Send email through Sendrealm using SMTP credentials
- [Templates](https://docs.sendrealm.com/tutorials/templates.md): Create reusable email templates in the dashboard with the visual editor or existing HTML.
- [Push Templates](https://docs.sendrealm.com/tutorials/push-templates.md): Create localized push templates for broadcasts and automations.
- [Mobile Push Credentials](https://docs.sendrealm.com/tutorials/mobile-push-credentials.md): Create Firebase and APNs credentials and upload them to the Sendrealm dashboard.
- [Web Push Setup](https://docs.sendrealm.com/tutorials/web-push.md): Configure Sendrealm Web Push and register browser subscriptions with the React SDK.
- [Events](https://docs.sendrealm.com/tutorials/events.md): Send customer events, understand system events, and trigger automations.
- [Automations](https://docs.sendrealm.com/tutorials/automations.md): Create event-driven journeys with templates, waits, conditions, and topic actions.
- [Automation Builder](https://docs.sendrealm.com/tutorials/automation-builder.md): Create, validate, test, and publish event-driven customer journeys from the dashboard.
- [Topics](https://docs.sendrealm.com/tutorials/topics.md): Manage reusable audience preference topics and subscription actions.
- [SDK Overview](https://docs.sendrealm.com/sdks/overview.md): Choose the right Sendrealm SDK for your app.
- [Android SDK](https://docs.sendrealm.com/sdks/android.md): Install and initialize the Sendrealm Android SDK.
- [iOS SDK](https://docs.sendrealm.com/sdks/ios.md): Install and initialize the Sendrealm iOS SDK.
- [React Native Bare SDK](https://docs.sendrealm.com/sdks/react-native-bare.md): Install and initialize Sendrealm in a bare React Native app.
- [React Native Expo SDK](https://docs.sendrealm.com/sdks/react-native-expo.md): Use Sendrealm with Expo development builds, prebuild, and EAS.
- [React Web Push SDK](https://docs.sendrealm.com/sdks/react.md): Use @sendrealm/react to register browser Web Push subscriptions.
- [JavaScript SDK](https://docs.sendrealm.com/sdks/javascript.md): Use the JavaScript and TypeScript SDK from trusted backend code.
- [Agent Skills](https://docs.sendrealm.com/agent-skills/overview.md): Use Sendrealm skills with AI coding agents.
- [Sendrealm Email Skill](https://docs.sendrealm.com/agent-skills/email.md): Help AI agents build Sendrealm email integrations.
- [Sendrealm Push Skill](https://docs.sendrealm.com/agent-skills/push.md): Help AI agents build Sendrealm push integrations.
- [Dashboard MCP](https://docs.sendrealm.com/agent-skills/dashboard.md): Use the Sendrealm MCP server to work with dashboard resources through an API key.
- [Introduction](https://docs.sendrealm.com/api-reference/introduction.md): General introduction for the Sendrealm API
- [Send Email](https://docs.sendrealm.com/api-reference/endpoint/create.md): Send emails
- [Get API Key Project](https://docs.sendrealm.com/api-reference/endpoint/project.md): Identify the project and safe dashboard capabilities associated with an API key.
- [List Domains](https://docs.sendrealm.com/api-reference/endpoint/domains.md): List the sending domains available to an API-key project.
- [Get Domain](https://docs.sendrealm.com/api-reference/endpoint/domain.md): Read a sending domain's DNS records and tracking settings without changing it.
- [List Campaigns](https://docs.sendrealm.com/api-reference/endpoint/list-campaigns.md): List email campaigns in the API key project.
- [Create And List Campaigns](https://docs.sendrealm.com/api-reference/endpoint/campaigns.md): Create email campaign drafts and list existing campaigns.
- [Retrieve And Update Campaign](https://docs.sendrealm.com/api-reference/endpoint/campaign.md): Read campaign readiness and update an email campaign draft.
- [Update Campaign](https://docs.sendrealm.com/api-reference/endpoint/update-campaign.md): Update metadata, sender, audiences, a published template version, tracking, or editor content. Only draft campaigns are editable; a sender must use a verified project domain.
- [Send Push Notification](https://docs.sendrealm.com/api-reference/endpoint/send-push-notification.md): Send a push notification to a direct device target or to contact aliases.
- [List Push Notifications](https://docs.sendrealm.com/api-reference/endpoint/list-push-notifications.md): List direct, campaign, automation, and test notification records with redacted provider state.
- [Start Push Live Activity](https://docs.sendrealm.com/api-reference/endpoint/start-push-live-activity.md): Start a Live Activity session for targeted push devices.
- [Send Push Live Activity Notification](https://docs.sendrealm.com/api-reference/endpoint/send-push-live-activity-notification.md): Send an update or end event to an existing Live Activity session.
- [Push Apps And Providers](https://docs.sendrealm.com/api-reference/endpoint/push-apps.md): Create push apps and inspect redacted provider readiness.
- [Create Push App](https://docs.sendrealm.com/api-reference/endpoint/create-push-app.md): Create a push app and default Android, iOS, and Web providers. Provider credentials remain dashboard-only.
- [Retrieve Push App](https://docs.sendrealm.com/api-reference/endpoint/retrieve-push-app.md)
- [Update Push App](https://docs.sendrealm.com/api-reference/endpoint/update-push-app.md): Rename a push app without changing provider credentials.
- [List Push App Providers](https://docs.sendrealm.com/api-reference/endpoint/list-push-app-providers.md): Return FCM, APNs, and Web Push readiness and public identifiers without secret credentials.
- [List Push Notification Channels](https://docs.sendrealm.com/api-reference/endpoint/list-push-notification-channels.md): List notification channels synchronized for a push app.
- [Push Devices](https://docs.sendrealm.com/api-reference/endpoint/push-devices.md): Find registered devices and inspect app-side integration state.
- [Retrieve Push Device](https://docs.sendrealm.com/api-reference/endpoint/retrieve-push-device.md): Return one device and recent registration, permission, and client events without raw provider tokens.
- [Push Tests](https://docs.sendrealm.com/api-reference/endpoint/push-tests.md): Send one real push test to one selected device and inspect its trace.
- [Retrieve Push Test](https://docs.sendrealm.com/api-reference/endpoint/retrieve-push-test.md): Poll a queued test and inspect provider and client events.
- [Push Campaign Drafts](https://docs.sendrealm.com/api-reference/endpoint/push-campaigns.md): Create, edit, preview, and single-device test push campaign drafts.
- [List Push Campaigns](https://docs.sendrealm.com/api-reference/endpoint/list-push-campaigns.md): List project push campaigns. Test-only delivery records are excluded.
- [Retrieve Push Campaign](https://docs.sendrealm.com/api-reference/endpoint/retrieve-push-campaign.md)
- [Update Push Campaign](https://docs.sendrealm.com/api-reference/endpoint/update-push-campaign.md): Update content, platforms, audiences, template selection, and platform configuration. Scheduling and launch are not accepted.
- [Preview Push Campaign Audience](https://docs.sendrealm.com/api-reference/endpoint/preview-push-campaign-audience.md): Count reachable subscribed devices by platform without sending.
- [Push Delivery Diagnostics](https://docs.sendrealm.com/api-reference/endpoint/push-delivery-diagnostics.md): List push sends and inspect provider and client event timelines.
- [Event Ingest](https://docs.sendrealm.com/api-reference/endpoint/events.md): Submit customer events and understand reserved system event rules.
- [List Templates](https://docs.sendrealm.com/api-reference/endpoint/list-templates.md): List template drafts and published templates.
- [Retrieve Template](https://docs.sendrealm.com/api-reference/endpoint/retrieve-template.md): Retrieve a single template.
- [List Template Versions](https://docs.sendrealm.com/api-reference/endpoint/list-template-versions.md): List template version history.
- [Create Automation](https://docs.sendrealm.com/api-reference/endpoint/create-automation.md): Create an automation draft.
- [List Automations](https://docs.sendrealm.com/api-reference/endpoint/list-automations.md): List existing automations.
- [Retrieve Automation](https://docs.sendrealm.com/api-reference/endpoint/retrieve-automation.md): Retrieve a single automation.
- [Update Automation](https://docs.sendrealm.com/api-reference/endpoint/update-automation.md): Update an automation draft.
- [Delete Automation](https://docs.sendrealm.com/api-reference/endpoint/delete-automation.md): Archive an automation.
- [Publish Automation](https://docs.sendrealm.com/api-reference/endpoint/publish-automation.md): Publish an automation draft.
- [Pause Automation](https://docs.sendrealm.com/api-reference/endpoint/pause-automation.md): Pause an active automation.
- [Resume Automation](https://docs.sendrealm.com/api-reference/endpoint/resume-automation.md): Resume a paused automation.
- [Automation Reliability](https://docs.sendrealm.com/api-reference/endpoint/automation-reliability.md): Validate definitions, control failed runs, and test waits without delivery.
- [List Automation Runs](https://docs.sendrealm.com/api-reference/endpoint/list-automation-runs.md): List runs for an automation.
- [Retrieve Automation Run](https://docs.sendrealm.com/api-reference/endpoint/retrieve-automation-run.md): Inspect a single automation run.
- [Cancel Automation Run](https://docs.sendrealm.com/api-reference/endpoint/cancel-automation-run.md)
- [Retry Automation Run](https://docs.sendrealm.com/api-reference/endpoint/retry-automation-run.md)
- [Start Automation Test Run](https://docs.sendrealm.com/api-reference/endpoint/start-automation-test-run.md)
- [Retrieve Automation Test Run](https://docs.sendrealm.com/api-reference/endpoint/retrieve-automation-test-run.md)
- [Inject Automation Test Event](https://docs.sendrealm.com/api-reference/endpoint/inject-automation-test-event.md)
- [Advance Automation Test Run](https://docs.sendrealm.com/api-reference/endpoint/advance-automation-test-run.md)
- [Create Topic](https://docs.sendrealm.com/api-reference/endpoint/create-topic.md): Create a reusable topic definition.
- [List Topics](https://docs.sendrealm.com/api-reference/endpoint/list-topics.md): List reusable topic definitions.
- [Retrieve Topic](https://docs.sendrealm.com/api-reference/endpoint/retrieve-topic.md): Retrieve a single topic.
- [Update Topic](https://docs.sendrealm.com/api-reference/endpoint/update-topic.md): Update a topic.
- [Delete Topic](https://docs.sendrealm.com/api-reference/endpoint/delete-topic.md): Delete a topic.
- [Update Contact Topic Subscription](https://docs.sendrealm.com/api-reference/endpoint/contact-topic-subscription.md): Subscribe or unsubscribe a contact from a topic.
- [Create Audience](https://docs.sendrealm.com/api-reference/endpoint/create-audience.md): Create an audience in the API key's project.
- [List Audiences](https://docs.sendrealm.com/api-reference/endpoint/list-audiences.md): List audiences in the API key's project.
- [Retrieve Audience](https://docs.sendrealm.com/api-reference/endpoint/retrieve-audience.md)
- [Update Audience](https://docs.sendrealm.com/api-reference/endpoint/update-audience.md)
- [Delete Audience](https://docs.sendrealm.com/api-reference/endpoint/delete-audience.md)
- [Create Audience Property](https://docs.sendrealm.com/api-reference/endpoint/create-audience-property.md)
- [List Audience Properties](https://docs.sendrealm.com/api-reference/endpoint/list-audience-properties.md)
- [Retrieve Audience Property](https://docs.sendrealm.com/api-reference/endpoint/retrieve-audience-property.md)
- [Update Audience Property](https://docs.sendrealm.com/api-reference/endpoint/update-audience-property.md)
- [Create Contact](https://docs.sendrealm.com/api-reference/endpoint/create-contact.md)
- [List Contacts](https://docs.sendrealm.com/api-reference/endpoint/list-contacts.md)
- [Retrieve Contact](https://docs.sendrealm.com/api-reference/endpoint/retrieve-contact.md)
- [Update Contact](https://docs.sendrealm.com/api-reference/endpoint/update-contact.md)
- [Delete Contact](https://docs.sendrealm.com/api-reference/endpoint/delete-contact.md)
- [Look Up Or Upsert Contacts](https://docs.sendrealm.com/api-reference/endpoint/contact-lookup-upsert.md): Resolve contacts by email without exposing email addresses in URLs.
- [Upsert Contact](https://docs.sendrealm.com/api-reference/endpoint/upsert-contact.md)
- [Attach Contact to Audience](https://docs.sendrealm.com/api-reference/endpoint/attach-contact-to-audience.md)
- [Remove Contact from Audience](https://docs.sendrealm.com/api-reference/endpoint/remove-contact-from-audience.md)

## OpenAPI Specs

- [openapi](https://docs.sendrealm.com/api-reference/openapi.json)

## Optional

- [Documentation](https://docs.sendrealm.com/)