Skip to content

UpsertCustomWorkflowActionInput ​

Type: Input

Input for creating a custom action, or fully overwriting one when id is supplied. Unlike updateCustomWorkflowAction, omitted optional fields are written as null.

Fields ​

NameTypeDefaultDescription
configSchemaStringOptional JSON Schema document (as a JSON string) for the action's configuration. Null clears it.
descriptionStringOptional tooltip / documentation text, max 1000 characters. On update, null clears any existing text.
iconStringOptional Lucide icon name, max 64 characters. On update, null clears any existing icon.
idCustomWorkflowActionIDTypeID (prefix cac) of the action to overwrite. Omit to create a new action; supplying an id that does not exist in this tenant is an error.
isActiveBooleanSoft enable/disable toggle. Omitted keeps the existing value on overwrite, and defaults to true when creating.
labelString!Human-readable display name shown in the UI. Required.
nameString!Machine-readable slug, unique per tenant. Must match ^[a-z][a-z0-9_-]{0,63}$.
pinToCurrentScriptBooleanTrue snapshots the script's current source into pinnedScriptContent, freezing the action against later script edits. False clears the pin. Omitted leaves an existing pin untouched (and pins nothing on create).
scriptIdScriptID!TypeID (prefix scr) of the Script implementing the action. Must reference a script in this tenant.

Connect machines, automate workflows, and build custom apps for print production.