Validate Workflow

Check the workflow's draft the way publishing will: errors block publishing (an incomplete schedule, a broken graph), warnings do not (a step not set up yet). Nothing changes.

POST

Path

Path parameters

stringrequired

The workflow's id.

Headers

Optional headers

string

Optional. The id of a child organization of your API key's company to act on. Leave it out to act on the key's own company. See Child organizations.

Response fields

validboolean

True when nothing blocks publishing. Warnings may remain.

revisionstring

The revision of the draft that was checked.

issuesarray of objects

Every problem found, errors first.

severitystring
error blocks publishing; warning does not.
- error
- warning
codestring
What is wrong, UPPER_SNAKE (SCHEDULE_INCOMPLETE, STEP_NOT_CONFIGURED, MISSING_GRAPH_REFERENCE, ...).
messagestring
What is wrong, for a person.
stepIdstring
The step or trigger it is about. Null for the workflow as a whole.
pathstring
Where that step sits in Get Workflow Definition, as a JSON Pointer (/steps/1/body/0). Null for the workflow as a whole.