Section ID:
Section ID:
DOC-API-MODEL-schema-p38aqgjs3a#overview
UpdateWorkflowPreferenceRequest
Inputs for changing the subscriber’s channel preferences for one notification workflow.
Meaning and usage
Section ID: DOC-API-MODEL-schema-p38aqgjs3a#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-p38aqgjs3a#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
In requests
Section ID: DOC-API-MODEL-schema-p38aqgjs3a#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-p38aqgjs3a#field-workflowidSection ID: DOC-API-MODEL-schema-p38aqgjs3a#request-field-workflowidworkflowId | string | Required in requests | Identifier of the notification workflow whose subscriber preferences are being changed. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-p38aqgjs3a#field-channelsSection ID: DOC-API-MODEL-schema-p38aqgjs3a#request-field-channelschannels | ChannelToggles | Optional | Channel switches to update for the subscriber. |
DOC-API-MODEL-schema-p38aqgjs3a#validation
Request validation
Section ID: DOC-API-MODEL-schema-p38aqgjs3a#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
Section ID: DOC-API-MODEL-schema-p38aqgjs3a#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 ID: DOC-API-MODEL-schema-p38aqgjs3a