Publish workflow

Validates and publishes the working draft of a workflow. On success (200) the new version becomes live and can accept runs. If the configuration fails validation the workflow is left unchanged and the call returns a 400 error whose message lists the problems — validation failures are not a 200 response. Beyond configuration validation, publish also returns a 400 when an ATS entry pathway names a job already connected to another workflow, campaign, or analysis (ATS_JOB_ALREADY_CONNECTED), or when automatic rubric generation for a screening node fails (RUBRIC_GENERATION_FAILED). Publish is also the only moment a workflow's ATS node targets are checked against the live ATS: a target that no longer exists returns a 400 (ATS_STAGE_NOT_FOUND, ATS_REJECTION_REASON_NOT_FOUND) naming the offending node, while an ATS that could not be reached at all returns a 503 (ATS_CHECK_UNAVAILABLE) — the configuration may be valid and the same request is worth repeating. See the workflow configuration guide for the full list of refusals.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Identifier of the workflow.

Body Params

Optional publish metadata.

Input for publishing a workflow. Body is optional — POST with no body to publish without change notes.

string

Optional human-readable description of what changed in this version. Stored alongside the workflow version for audit purposes.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json