Notification API

List announcements with pagination (admin only)

List the email providers of a specific tenant (PlatformAdmin only). Mirrors emailProviders but takes the target tenant from the argument instead of the request context, so platform admins can inspect a tenant they're not impersonating. Used by the admin tenant detail page.

List the tenant-owned push providers of a specific tenant (PlatformAdmin only). Mirrors pushProviders(ownership: TENANT) but takes the target tenant from the argument instead of the request context, so platform admins can inspect a tenant they're not impersonating. Used by the admin tenant detail page.

List the SMS providers of a specific tenant (PlatformAdmin only). Mirrors smsProviders but takes the target tenant from the argument instead of the request context, so platform admins can inspect a tenant they're not impersonating. Used by the admin tenant detail page.

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 the email scenario definitions configurable from the caller's panel. Platform admins get platform + shared scenarios; tenant owners/admins get tenant + shared scenarios. Each definition carries its default subject, description, and the variables the system provides. # Authorization Requires PlatformAdmin, TenantOwner, or TenantAdmin role.

Get a specific email template by ID. Returns None when the template's scenario is outside the caller's panel, so existence is not leaked across roles. # Authorization Requires PlatformAdmin, TenantOwner, or TenantAdmin role.

Get the active email template for a specific scenario. Returns None when the scenario is outside the caller's panel. # Authorization Requires PlatformAdmin, TenantOwner, or TenantAdmin role.

List the email templates configurable from the caller's panel. Templates whose scenario is outside the caller's role (e.g. a platform billing scenario for a tenant admin) are filtered out so the list stays coherent with [super::EmailScenarioDefinitionQuery]. # Authorization Requires PlatformAdmin, TenantOwner, or TenantAdmin 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 single push provider by id (admin only).

List push providers for an owner scope (admin only). Defaults to the caller's tenant-owned providers; ownership: PLATFORM lists the shared platform providers and requires a platform admin.

Get a specific SMS provider by ID (admin only)

Every SMS gateway, ranked for the given countries. Pass the tenant's operating countries (from myOperationFootprint) to get per-country prices, a coverage verdict, and a recommendation. Pass an empty list to get the bare catalog — credential schemas and integration status, with no pricing.

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 an admin-tier role *and* that the scenario belongs to the caller's panel (tenant admins cannot create platform templates, and vice versa).

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 an admin-tier role; the template's scenario must belong to the caller's panel (enforced in the use case once the template is loaded).

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 an iOS ActivityKit Live Activity push token for direct APNs delivery of content-state updates.

Register a push notification token for the authenticated device

Remove the push token for the authenticated device (call on logout).

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 an admin-tier role *and* that the scenario belongs to the caller's panel — a tenant cannot test-send a platform scenario, and vice versa.

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 an admin-tier role; the template's scenario must belong to the caller's panel (enforced in the use case once the template is loaded).

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