Skip to content
Proud to collaborate with Microsoft for Startups

lumen.org.set-retention ​

Update the log-retention window (retention_days) for an organization's Lumen plan without altering the plan tier or rate limit.

Upsert the retention_days field of an org's Lumen plan row.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-lumen
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes—Public UUID of the org whose retention window is being updated.
retention_daysintegerYes—New retention period in days (must be > 0).
workflow_run_idstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringNo——
planstringNo——
rate_limit_per_minuteintegerNo——
retention_daysintegerNo——
enabledbooleanNo——
provisionedbooleanNo——
reasonstringNo——
http_statusintegerNo——
detailstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——
workflow_run_idstringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "lumen.org.set-retention",
  "initial_data": {
    "organization_uuid": "value",
    "retention_days": 123
  }
}