Skip to content
Proud to collaborate with Microsoft for Startups

data.identity.notification-pref.update ​

Patch an active UserNotificationPreference row

Patch an existing (non-deleted) UserNotificationPreference row.

Input: preference_uuid + organization_uuid (required), optional patch fields. Output in state_data: preference_uuid, updated_fields (list), updated_at.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
preference_uuiduuidYes——
organization_uuiduuidYes——
in_app_enabledbooleanNo——
email_enabledbooleanNo——
email_digeststringNo——
quiet_hours_enabledbooleanNo——
quiet_hours_startstringNo——
quiet_hours_endstringNo——
quiet_hours_timezonestringNo——
muted_untilstringNo——
clear_mutebooleanNo——
actorstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
preference_uuidstringYes——
updated_fieldslistYes——
updated_atstringYes——
organization_uuiduuidNo——
actorstringNo——
in_app_enabledbooleanNo——
email_enabledbooleanNo——
email_digeststringNo——
quiet_hours_enabledbooleanNo——
quiet_hours_startstringNo——
quiet_hours_endstringNo——
quiet_hours_timezonestringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completeUpdate notification preference
completedNoYesYes—Updated
failedNoYesNo—Update failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.identity.notification-pref.update",
  "initial_data": {
    "preference_uuid": "value",
    "organization_uuid": "value"
  }
}