Dry-run (validate) a workflow
Validates a workflow without running it or causing any side effect. It checks that the workflow's current definition is executable, that the trigger's referenced survey and ending cards still exist in the workspace, and that every send_email action addressing a literal email address targets someone who can access this workspace. No workflow run is created and no email or webhook is sent.
The response is always 200 with { data: { workflowId, ok, problems } }. data.ok is true when the workflow would execute; otherwise data.problems lists every issue found — each with a machine-readable code and the offending field — so they can be fixed in a single pass.
Drafts are testable — validating the setup before going live is the point of a dry run. Only an archived workflow is rejected, with 422 and code invalid_workflow_state.
Path parameters
Workflow identifier.
Response
Validation result. The request succeeded; inspect data.ok to see whether the workflow is ready, and data.problems for any issues.
Example response
{
"data": {
"workflowId": "clworkflow0000000000000000"
}
}