Send a notification with digest aggregation

POST 
/api/v1/notifications/manage/send-with-digest

Triggers a notification workflow that must already have a digest step configured. The workflow’s configured digest window determines whether and how events are batched before delivery; this operation does not create that digest configuration.

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: Send notifications

Request

Responses

200

Digest notification accepted

Submit one event to a workflow that already has a digest step configured.

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

Request example

{
  "workflowId": "activity-digest",
  "userId": "user-1",
  "payload": {
    "title": "Account activity",
    "body": "A new report is available."
  }
}

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

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

Response example

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

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

Section	Stable reference
Send a notification with digest aggregation	DOC-CP-notifications-api-sendWithDigest#overview
Request	DOC-CP-notifications-api-sendWithDigest#request
Responses	DOC-CP-notifications-api-sendWithDigest#responses