Send a notification to all topic subscribers

POST 
/api/v1/notifications/manage/send-to-topic

Broadcasts a notification to all subscribers of the specified topic. Optionally excludes a single user (e.g., the action originator).

Acceptance is not a delivery or read receipt. Workflow configuration, recipient preferences and provider delivery can produce later failures or suppression. A transactionId is a provider correlation/deduplication input, not an unlimited exactly-once guarantee or an authorization grant; reconcile uncertain sends before retrying.

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: Broadcast with topics · Push registration and topic delivery

Request

Responses

200

Topic notification trigger accepted; delivery is separate

Trigger a prepared workflow for subscribers to an existing topic.

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

Request example

{
  "workflowId": "push-notification",
  "topicKey": "product-updates",
  "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-sendToTopic#example-notifications-sendToTopic-response

Response example

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

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

Section	Stable reference
Send a notification to all topic subscribers	DOC-CP-notifications-api-sendToTopic#overview
Request	DOC-CP-notifications-api-sendToTopic#request
Responses	DOC-CP-notifications-api-sendToTopic#responses