Publish Workflow

Publish a workflow so the current draft becomes the active published version. You can optionally provide a title and description for the version changelog.

The request body is the same regardless of the workflow's graph structure — you only need the current checksum and optional version metadata.

You can obtain the latest checksum from:

• Create workflow response (data.checksum), or

• Update workflow response (data.checksum), or

• Get workflow by id (data.checksum) — most reliable; always reflects server state.

Publish workflow

post

Publish a workflow — promotes the current draft to an active published version.

Prerequisites:

• The workflow must have been tested at least once after the last update (testedAt must be non-null).

• checksum must match the server's current value. Get it from: Create response, Update response, or GET /dev/v1/workflow/{entity-id} → data.checksum.

title and description are optional version changelog fields — use them to label releases (e.g. v1.0, Hotfix-2026-05).

To retrieve a specific published version's graph later, call GET /dev/v1/workflow/{entity-id}?version=v1.

Canonical response file: examples/publish_workflow_200.json

Authorizations

Nected-API-KeystringRequired

Your Nected API key. Obtain from your workspace settings.

Path parameters

entity-idstringRequired

The workflow entity ID

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Header parameters

Nected-BranchstringOptional

Branch name (optional)

Body

Request body for the publish endpoint

checksumstringOptional

Current checksum of the workflow — must match server state

titlestringOptional

Short title for this published version (e.g. v1.0)

descriptionstringOptional

Changelog / description for this version

Responses

200

OK — workflow published.

application/json

Standard API response wrapper

codestringOptional

dataanyOptional

Response payload — shape varies by endpoint

messagestringOptional

pageNointegerOptional

pageSizeintegerOptional

totalCountintegerOptional

totalPagesintegerOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

post/dev/v1/workflow/{entity-id}/publish

POST /dev/v1/workflow/{entity-id}/publish HTTP/1.1
Host: api.nected.ai
Nected-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "checksum": "7f3d2a1b9c8e4f6a0d5b2c7e1a9f3d8c",
  "title": "v1.0",
  "description": "Initial production release — gold/silver/standard discount tiers."
}

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "version": "v1",
    "publishedAt": "2026-05-31T10:00:00.000Z"
  },
  "code": "success",
  "message": "Workflow Published Successfully."
}

Copy-paste JSON example

{
  "checksum": "7f3d2a1b9c8e4f6a0d5b2c7e1a9f3d8c",
  "title": "v1.0",
  "description": "Initial production release."
}