Bulk-update per-workflow preferences
POST/api/v1/notifications/bulk-update-preferences
Updates channel toggles for multiple workflows in a single request.
Updates can partially apply before a later failure. Re-read preferences and retry only unresolved changes; a request failure does not imply an atomic rollback.
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: Manage notification preferences · Preferences and channel inheritance
Request
Responses
- 200
Preferences bulk-updated
Update two existing workflows; inspect the per-entry outcomes.
Section ID: DOC-CP-notifications-api-bulkUpdatePreferences#example-notifications-bulkUpdatePreferences-request
Request example
{
"entries": [
{
"workflowId": "promotional",
"channels": {
"push": false
}
},
{
"workflowId": "weekly-summary",
"channels": {
"inApp": true,
"push": true
}
}
]
}
Illustrative response shape; omitted default fields and actual outcomes depend on the operation.
Section ID: DOC-CP-notifications-api-bulkUpdatePreferences#example-notifications-bulkUpdatePreferences-response
Response example
{
"updatedCount": 1
}
Document ID: DOC-CP-notifications-api-bulkUpdatePreferences. Section identities and revisions.
| Section | Stable reference |
|---|---|
| Bulk-update per-workflow preferences | DOC-CP-notifications-api-bulkUpdatePreferences#overview |
| Request | DOC-CP-notifications-api-bulkUpdatePreferences#request |
| Responses | DOC-CP-notifications-api-bulkUpdatePreferences#responses |