Run (test) a workflow by name — confirm-gated
POST/v1/workflows/run-by-name
Run a workflow immediately, looked up by name instead of id.
Optional inputs become the trigger payload the first node reads. This is a
real execution against real data — nodes send email, write to your CRM and
call live integrations — so the call is confirm-gated: without confirm: true
you get back what would run, and with it the workflow actually executes.
Names are not guaranteed unique; prefer POST /v1/workflows/{workflow_id}/run
when you already hold the id. Requires the workflows:run scope.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 429
Successful Response
Error
Error
Error
Error
Validation Error
Error