Appearance
identity.notification-pref.update ​
Update the current user's notification preferences
Patch the current user's notification preferences for an organization.
Inputs:
- actor: Cognito sub or user UUID (required)
- organization_uuid: Organization ID (required)
- preference_uuid: optional override; when omitted, resolved from actor+org
- in_app_enabled, email_enabled, email_digest (optional)
- quiet_hours_enabled, quiet_hours_start, quiet_hours_end, quiet_hours_timezone (optional)
Outputs (terminal state_data):
- preference_uuid
- updated_fields
- created: true if the row had to be persisted first
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-identity |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
actor | string | Yes | — | — |
organization_uuid | uuid | Yes | — | — |
preference_uuid | uuid | No | — | — |
in_app_enabled | boolean | No | — | — |
email_enabled | boolean | No | — | — |
email_digest | string | No | — | — |
quiet_hours_enabled | boolean | No | — | — |
quiet_hours_start | string | No | — | — |
quiet_hours_end | string | No | — | — |
quiet_hours_timezone | string | No | — | — |
muted_until | string | No | — | — |
clear_mute | boolean | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
actor | string | No | — | — |
organization_uuid | uuid | No | — | — |
preference_uuid | string | No | — | — |
updated_fields | list | No | — | — |
created | boolean | Yes | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "identity.notification-pref.update",
"initial_data": {
"actor": "value",
"organization_uuid": "value"
}
}