Docs

Publish Workflow

Make the draft the version that runs. The draft is checked first, exactly as Validate Workflow checks it; meta.warnings lists what is not set up yet. Send the revision you last read in If-Match. The draft is unchanged, so meta.revision stays the same.

POST

Path

Path parameters
stringrequired

The workflow's id.

Headers

Optional headers
stringrequired

Required. The draft revision you last read (the revision from Get Workflow Definition, or meta.revision from your last change). The change applies only if nobody changed the draft since: otherwise it answers 412 with the current revision in error.details.revision. Send it as a strong entity tag ("r_..."): a weak one (W/"...") never matches and answers 412. Without it the request answers 428.

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.

Body

Arguments
string

What changed in this version.

string

patch, minor or major.

Which part of the version number goes up. patch (the default): 0.0.14 to 0.0.15.

Default: patch

  • patch
  • minor
  • major

Response fields

versionstring

The new version number.

descriptionstring

What changed in this version.

isPublishedboolean

Always true: this version now runs.

createdOndate

When it was published.