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

Section ID: DOC-CP-notifications-api-sendNotification#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.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Send notifications · Welcome a new user with an in-app message

Request

Responses

200

Notification trigger accepted; delivery is separate

Trigger the prepared welcome workflow for an enrolled user; replace the workflow and user identifiers.

Section ID: DOC-CP-notifications-api-sendNotification#example-notifications-sendNotification-request

Request example

{
  "workflowId": "welcome-notification",
  "userId": "user-1",
  "payload": {}
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.

Section ID: DOC-CP-notifications-api-sendNotification#example-notifications-sendNotification-response

Response example

{
  "acknowledged": true,
  "status": "example",
  "transactionId": "example_123",
  "errors": [
    "example"
  ]
}

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

Section	Stable reference
Send a notification to a user	DOC-CP-notifications-api-sendNotification#overview
Request	DOC-CP-notifications-api-sendNotification#request
Responses	DOC-CP-notifications-api-sendNotification#responses