Send a notification to multiple users

POST 
/api/v1/notifications/manage/send-bulk

Submits per-recipient notification events together. A batch can mix workflows.

Results are per-event: one recipient failing does not fail the others. Inspect each entry's acknowledged and errors rather than the HTTP status alone. Accepted triggers are not delivery receipts, and retrying an entire partially accepted batch can duplicate work.

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

Request

Responses

200

Bulk notification results

Trigger a prepared workflow for two enrolled users; inspect every returned result.

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

Request example

{
  "events": [
    {
      "workflowId": "push-notification",
      "userId": "user-1",
      "payload": {
        "title": "Update",
        "body": "New feature available"
      }
    },
    {
      "workflowId": "push-notification",
      "userId": "user-2",
      "payload": {
        "title": "Update",
        "body": "New feature available"
      }
    }
  ]
}

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

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

Response example

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

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

Section	Stable reference
Send a notification to multiple users	DOC-CP-notifications-api-sendBulkNotification#overview
Request	DOC-CP-notifications-api-sendBulkNotification#request
Responses	DOC-CP-notifications-api-sendBulkNotification#responses