Skip to main content
POST
Re-pin procedure nodes of a draft
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

POST /api/v2/workflows/repinProcedure The API twin of the Console’s bulk re-pin. Each node’s inputs and outputs re-hydrate from the new version. A renamed output is repaired only where you accept the preview’s suggestion in acceptedRepairs; any other binding the new version cannot satisfy is cut and reported in dropped. A node deleted, re-pointed at another procedure or already at the version since the preview is skipped as stale (skippedStale); a node whose re-pin failed is in skipped with its reason. consumerWalkSkipped counts nodes whose downstream walk did not run: their bindings are unknown, and the publish validator is the remaining check.

Authentication

Personal key, External App credential or platform API key. Requires permission workflows:write, and workflows:write and workflows:read held at the workflow’s home org unit. Every node must belong to that workflow’s draft.

Headers

string
Optional. A same-key retry within 24 hours returns the recorded answer without re-pinning again, only while you may still read the workflow it names; otherwise 409 idempotency_result_unavailable. The same key with a different body is 422. See Idempotency.

Body

string
required
The workflow id.
string[]
required
The draft nodes to re-pin, 1 to 50.
string
required
The procedure the nodes call.
string
required
The procedure version to pin.
object[]
Rename suggestions from the preview to apply: consumerNodeId, input, output, suggestedTo.

Responses

200 with data.workflowId, data.draftId, data.repinned, data.skipped, data.skippedStale, data.repaired, data.dropped, data.consumerWalkSkipped and data.unattributed.

Errors

Example

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

workflowId
string
required

The workflow id; every node must belong to its draft.

Minimum string length: 1

Body

application/json
nodeIds
string[]
required

The draft nodes to re-pin (1-50), from the preview's rows.

Required array length: 1 - 50 elements
Minimum string length: 1
procedureId
string
required

The procedure the nodes call.

Minimum string length: 1
version
string
required

The procedure version to pin.

Minimum string length: 1
acceptedRepairs
object[]

Rename suggestions from the preview to apply; any other is dropped and reported.

Response

The re-pin's outcome

data
object
required
meta
object
required