Workflows
Workflows in Type CMS enable project administrators to implement structured review cycles for content, ensuring high standards of quality and compliance before publication. These workflows can include multiple stages such as creative review, legal review, and executive review, tailored to meet specific content requirements. Administrators can apply workflows to all content, specific entries, or particular content types, providing granular control over the publication process. This ensures content is only published after meeting all necessary criteria and approvals.
List all workflows in a project
Required attributes
| projectId | string | Your projectId |
Optional attributes
| None |
Request
Response
Retrieves a single workflow based on the provided workflow ID
Required attributes
| projectId | string | Your project ID |
| workflowId | string | The ID of the workflow to retrieve |
Optional attributes
| None |
Request
Response
Creates a new workflow
Required attributes
| projectId | string | Your project ID |
| title | string | The name of the new workflow |
Optional attributes
| description | string | A description for the new workflow |
| pipeline | pipelineObject[] | An array of pipeline objects (workflow stages) for the workflow |
| conditions | conditionsObject |
Request
Response
Updates attributes for a workflow. Any workflows that are currently in progress on an entry will continue with the previous version of the workflow. Any subsequent workflows will include the updates from this operation.
Required attributes
| projectId | string | Your project ID |
| workflowId | string | The ID of the workflow to update |
Optional attributes
| title | string | The name of the workflow |
| description | string | A description for the workflow |
| pipeline | pipelineObject[] | An array of pipeline objects (workflow stages) for the workflow |
| conditions | conditionsObject[] | An array of workflow conditions to apply to the workflow |
Request
Response
Deletes a workflow. This will also cancel any workflows currently in progress for associated entries.
Required attributes
| projectId | string | Your project ID |
| workflowId | string | The ID of the workflow to remove |
Optional attributes
| None |
Request
Response