Skip to content
Proud to collaborate with Microsoft for Startups

data.identity.organization.soft_delete ​

Soft-delete an Organization row

Soft-delete an Organization row (set deleted_at / deleted_by).

Input: organization_uuid, organization_uuid (tenant check), optional actor. Output in state_data: organization_uuid, deleted, already_deleted, deleted_at.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization ID (tenant check)
actorstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
deletedbooleanYes——
already_deletedbooleanYes——
deleted_atstringNo——
actorstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completeSoft-delete organization
completedNoYesYes—Deleted
failedNoYesNo—Delete failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

API Usage ​

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

{
  "workflow_type": "data.identity.organization.soft_delete",
  "initial_data": {
    "organization_uuid": "value"
  }
}