UpdateWorkflowPreferenceRequest
Inputs for changing the subscriber’s channel preferences for one notification workflow.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
workflowId | string | Required in requests | Identifier of the notification workflow to execute or configure. Minimum length: 1. |
channels | ChannelToggles | Optional | Channel switches to update for the subscriber. |
Request validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
workflowId | Minimum length | 1 |
Where used
| Reference | Relationship |
|---|---|
| Bulk-update per-workflow preferences | POST /api/v1/notifications/bulk-update-preferences |
| Update per-workflow notification preferences | POST /api/v1/notifications/update-workflow-preference |
Download the public reference contract.
Document: DOC-API-MODEL-update-workflow-preference-request.