Skip to main content

Update per-workflow notification preferences

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

Updates the subscriber's channel toggles for a single workflow. 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​

Workflow preference updated

Disable push for an existing workflow while leaving other channels unchanged.​

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

Request example

{
  "workflowId": "promotional",
  "channels": {
    "push": false
  }
}

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

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

Response example

{}

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

SectionStable reference
Update per-workflow notification preferencesDOC-CP-notifications-api-updateWorkflowPreference#overview
RequestDOC-CP-notifications-api-updateWorkflowPreference#request
ResponsesDOC-CP-notifications-api-updateWorkflowPreference#responses