Edit Workflow Settings
cascade_edit_workflow_settingsUpdate workflow settings for a Cascade container (folder/site). Optionally propagate inherit or require workflow settings to children.
Instructions
Update workflow settings for a Cascade container (folder/site). Optionally propagate to children.
Replaces the container's workflow configuration wholesale. Two boolean flags control propagation: applyInheritWorkflowsToChildren copies the "inherit" setting to descendants, applyRequireWorkflowToChildren copies the "required" setting. Call cascade_read_workflow_settings first so you can pass the existing workflowSettings with only your edits.
Args:
identifier (object, required): The container to update
id (string, optional): Container ID (preferred)
path (object, optional): { path, siteId OR siteName }
type (string, required): Typically "folder" or "site"
workflowSettings (object, required, shape varies — see Cascade docs): Complete replacement workflow configuration
workflowDefinitions (array): Which workflows apply in this container
inheritWorkflows (boolean): Whether to inherit from parent
requireWorkflow (boolean): Whether workflow is mandatory for edits
applyInheritWorkflowsToChildren (boolean, optional, default false): Propagate inheritWorkflows to descendants
applyRequireWorkflowToChildren (boolean, optional, default false): Propagate requireWorkflow to descendants
Returns: Cascade OperationResult: { success: true } On failure: { success: false, message: "" }
Examples:
Use when: "Require workflow on /releases and all its children" -> set requireWorkflow: true + applyRequireWorkflowToChildren: true.
Use when: "Swap a workflow definition on a folder" -> pass the new workflowDefinitions array.
Don't use when: You want to advance an in-flight workflow — use cascade_perform_workflow_transition.
Don't use when: You only need to read — use cascade_read_workflow_settings.
Error Handling:
"Asset not found" when the identifier doesn't resolve
"Invalid workflow definition" when a referenced workflow ID is wrong
"Permission denied" when credentials lack admin rights. Responses are JSON text; structuredContent is authoritative when the response fits. Oversized responses return bounded _cache metadata for cascade_read_response. For cascade_read, read_mode controls preview versus raw Cascade payload shape.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | No | The folder whose workflow settings to modify. | |
| workflowSettings | No | REQUIRED: Workflow settings payload (inheritWorkflows, requireWorkflow, workflowDefinitions, etc.). Matches Cascade's WorkflowSettingsSend shape. | |
| applyInheritWorkflowsToChildren | No | Apply the 'inheritWorkflows' setting to child folders (default: false). | |
| applyRequireWorkflowToChildren | No | Apply the 'requireWorkflow' setting to child folders (default: false). |