Appearance
data.identity.notification-pref.soft_delete ​
Soft-delete a UserNotificationPreference row (idempotent)
Soft-delete a UserNotificationPreference row (idempotent).
Input: preference_uuid + organization_uuid (required), optional actor. Output in state_data: preference_uuid, deleted, already_deleted, deleted_at.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-identity |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
preference_uuid | uuid | Yes | — | — |
organization_uuid | uuid | Yes | — | Tenant check — must match the preference's organization |
actor | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
preference_uuid | uuid | Yes | — | — |
deleted | boolean | Yes | — | — |
already_deleted | boolean | Yes | — | — |
deleted_at | string | No | — | — |
organization_uuid | uuid | No | — | — |
actor | string | No | — | — |
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 | — | complete | Soft-delete notification preference |
completed | No | Yes | Yes | — | Deleted |
failed | No | Yes | No | — | Delete failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | complete | completed | — |
pending | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "data.identity.notification-pref.soft_delete",
"initial_data": {
"preference_uuid": "value",
"organization_uuid": "value"
}
}