Deliver a notification to specific users

Path Params
string
required

Tenant identifier.

string
required
Body Params
string
required

User OpenID to deliver the notification to. Note: must be a non-empty string, and can only have a single recipient per delivery request. For multiple recipients, make multiple API calls.

string

Brand code to apply for the notification delivery. Note: if brandCode is provided, must be a non-empty string, and must exist in the system when provided. If no brandCode is provided, the Tenant's default branding will be used.

string
enum
required
Defaults to en-CA

Locale in [ISO 639-1]-[ISO 3166-1] format.

Allowed:
notificationKeys
array of objects

Parameters for notification template substitution.

Usage:

  • Array of key-value objects for template variable substitution
  • Each object contains a key and value for template processing
  • Example: [{"key": "userName", "value": "John"}, {"key": "companyName", "value": "Acme Corp"}]
  • Used for both title and body template parameters
  • Maximum 20 parameter objects allowed

Template Access Examples:

  • In template: "Welcome {{userName}} to {{companyName}}!"
  • Result: "Welcome John to Acme Corp!"
  • Title template: "{{userName}}, you have a new message from {{companyName}}"
  • Body template: "Hello {{userName}}, {{companyName}} has sent you an important notification. Please check your account for details."

Supported Template Syntax:

  • Standard handlebars syntax for variable substitution
  • Variables are case-sensitive and must match the exact key provided
  • Undefined variables will render as empty strings in the template
notificationKeys
Responses
201

Notification delivered successfully.

403

Forbidden.

404

Notification type not found.

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here!