Skip to main content

Send a notification to a user

POST 

/api/v1/notifications/manage/send

Sends a notification to a single user by triggering a notification workflow. The configured workflow determines its delivery channels.

A transactionId is a provider correlation/deduplication input, not an unlimited exactly-once guarantee or an authorization grant; reconcile uncertain sends before retrying.

Workflow definitions and payload variables​

workflowId selects a prepared notification workflow containing its channels and message templates. Discover workflows through list workflows. The send operation renders that workflow with the supplied payload variables; it does not accept arbitrary message text outside the template contract.

Save the returned transactionId and any one you supplied. Use it for cancelling and checking delivery.

Inspect the trigger acknowledgment and errors before treating the send as accepted. Acceptance does not confirm delivery or a read receipt: workflow configuration, recipient preferences and provider delivery can produce later failures or suppression. Check delivery status for the subsequent channel attempts.

Request​

Responses​

Notification trigger accepted; delivery is separate

Document ID: DOC-CP-notifications-api-sendNotification. Section identities and revisions.

SectionStable reference
OverviewDOC-CP-notifications-api-sendNotification#overview
RequestDOC-CP-notifications-api-sendNotification#request
ResponsesDOC-CP-notifications-api-sendNotification#responses