Skip to main content

Update global notification preferences

POST 
/api/v1/notifications/update-global-preference

Updates the subscriber's global (all-workflow) channel toggles. Omitted channels are left unchanged.

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

Request​

Responses​

Global preference updated

Disable push notifications while leaving omitted channels unchanged.​

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

Request example

{
  "channels": {
    "push": false
  }
}

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

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

Response example

{}

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

SectionStable reference
Update global notification preferencesDOC-CP-notifications-api-updateGlobalPreference#overview
RequestDOC-CP-notifications-api-updateGlobalPreference#request
ResponsesDOC-CP-notifications-api-updateGlobalPreference#responses