Skip to content
Proud to collaborate with Microsoft for Startups

publisher.cover_kit.upsert ​

Create or rename a cover kit — a named set of brand images a profile draws its covers from.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-publisher
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
workflow_run_idstringNo—Parent DAG workflow run id (engine-injected when used as a step)
organization_uuidstringYes——
cover_kit_uuidstringNo—Omit to create a new kit; pass to rename an existing one
namestringYes—Kit name, unique per organization
statusstringNo—draft

Output Schema ​

FieldTypeRequiredDefaultDescription
workflow_run_idstringNo—Parent DAG workflow run id (engine-injected when used as a step)
organization_uuidstringYes——
cover_kit_uuidstringNo——
namestringNo——
statusstringNo——
createdbooleanNo——
failure_reasonstringNo—Engine-stamped human-readable failure reason
failed_atstringNo—ISO timestamp when the workflow failed
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerintegerNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name
completed_atstringNo——

States ​

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

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
completedSUCCESSPublisher atom completed successfullycompleted_at
failedFAILUREPublisher atom failedfailure_reason, error, error_type

API Usage ​

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

{
  "workflow_type": "publisher.cover_kit.upsert",
  "initial_data": {
    "organization_uuid": "value",
    "name": "value"
  }
}