Send a notification to a party

POST /v1/notifications

Required States: Various based on notification type

This endpoint sends notifications across multiple channels (SMS, EMAIL, DEVICE) with support for:

Authentication & Context:

Party and user identifiers are automatically extracted from the JWT token
GENERAL notifications require a valid party session (partyId from JWT)
All notifications require a valid user session (userId from JWT) for audit tracking

Message Types:

MARKETING: Can be sent to non-registered parties, requires template ID, supports scheduling
VERIFICATION: Can be sent to non-registered parties, requires template ID, cannot be scheduled
GENERAL: Requires authenticated party session, supports free text or templates, supports scheduling

Business Rules & Validation:

Channel identifier must be in valid format: phone numbers in E.164 format (+61491570006), valid email addresses, or valid device IDs
For test environments, SMS notifications are restricted to allow-listed phone numbers only
VERIFICATION messages cannot be scheduled for future delivery
MARKETING and VERIFICATION messages must include a templateId, GENERAL messages can use either templateId or free text messageContent
Template variables are validated against the template requirements
Scheduled delivery times must be in the future and in valid ISO 8601 format

Channel Specific Requirements:

SMS: Phone numbers must be in E.164 format (e.g., +61491570006), allow-list restrictions apply in test environments
EMAIL: Valid email address format required, delivery via configured email service
DEVICE: Valid device ID/token required, push notification delivery via the push notification service

Template Processing:

Templates are retrieved based on templateId, messageType, contactChannel, clientId, and brandId
Template variables are substituted using {{variableName}} syntax
Missing required template variables will cause validation failure

Request

Notification sent successfully