Notification API

List announcements with pagination (admin only)

Get a single announcement by ID (admin only)

Query active announcements targeted at the current account. The app is taken from the x-app request header.

Get a specific email provider by ID

Get a specific email provider definition by ID

List all available email provider definitions for the tenant

List all email providers for the tenant

List all email scenario definitions with their metadata. Returns every possible email scenario with default subject, description, and the variables the system provides. # Authorization Requires PlatformAdmin or TenantAdmin role.

Get a specific email template by ID. # Authorization Requires PlatformAdmin role.

Get the active email template for a specific scenario. # Authorization Requires PlatformAdmin role.

List all email templates for the tenant. # Authorization Requires PlatformAdmin role.

Query live activities for the current account

Get the current user's notification preferences. Returns preferences grouped by category, filtered for the caller's app and role. Merges tenant defaults with user overrides.

Query durable notifications for the current account

Get a specific SMS provider by ID (admin only)

Full SMS provider coverage matrix. Globally-available providers report an empty country_codes list with is_global = true.

List all SMS providers for the tenant (admin only)

SMS providers available in the given country. Includes globally- available providers (Twilio, Infobip, etc.) in every response. country_code must be an ISO 3166-1 alpha-2 code (case-insensitive).

Get a specific SMS template by ID

List all SMS templates for the tenant

Get unread count for an app

Create an announcement (admin only)

Create a new email provider configuration

Create a custom email provider definition (SMTP or HTTP Webhook)

Create a new email template. # Authorization Requires PlatformAdmin role.

Create a new durable notification

Create a new SMS provider (admin only)

Create a new SMS template

Deactivate a custom email provider definition

Delete an announcement (admin only)

Delete an email provider

Delete an email template. # Authorization Requires PlatformAdmin role.

Delete an SMS provider (admin only)

Delete an SMS template

Dismiss a notification

End a live activity

Mark all notifications as read

Mark a notification as read

Register a push notification token for the authenticated device

Send a test email for the given scenario, using the caller's tenant's default email provider and its configured template. Always returns the rendered preview. When dryRun is true the email is rendered but not dispatched, so admins can verify placeholder substitution before committing to a real send. # Authorization Requires PlatformAdmin or TenantAdmin.

Set an email provider as the default for the tenant

Set an SMS provider as the default (admin only)

Test an SMS provider by sending a test message (admin only)

Update an announcement (admin only)

Update an existing email provider

Update a custom email provider definition

Update an existing email template. # Authorization Requires PlatformAdmin role.

Update a live activity

Update the current user's notification preferences. Accepts a list of preference changes (subject + channel + enabled). Only marketing/optable subjects can be toggled — transactional and OTP subjects are rejected. Returns the full updated preferences after applying changes.

Update an existing SMS provider (admin only)

Update an existing SMS template