Update a workflow node run
PATCH/v1/workflows/nodes/runs/:node_run_identifier
This route allows you to update the status, result, or output of a workflow node run.
To learn more about workflows, see the documentation.
Request
Parameters (JSON)
{
"parameters": [
{
"schema": {
"type": "string",
"pattern": "^wfnr_[a-zA-Z0-9]{16}$"
},
"in": "path",
"name": "node_run_identifier",
"required": true,
"description": "The unique identifier of the workflow node run."
}
]
}Request body schema (JSON)
{
"title": "Body",
"body": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"description": "The new status of the node run.",
"type": "string",
"enum": [
"COMPLETED",
"IN_PROGRESS"
]
},
"result": {
"description": "The result of the node run (e.g., SUCCESS, FAILED).",
"type": "string",
"enum": [
"SUCCESS",
"FAILED"
]
},
"output": {
"description": "Output data produced by the node run.",
"default": {},
"type": "object",
"additionalProperties": {}
},
"externalRunId": {
"description": "The external run ID to associate with this node run.",
"type": "string"
},
"links": {
"description": "Links to attach to this node run, replacing any previously attached links. Pass an empty array to clear them. When omitted, the links configured on the node are appended to the existing ones.",
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"statusLabel": {
"description": "A custom status label to display on this node run. Overrides any label set by the node configuration. Pass null to clear an existing label.",
"nullable": true,
"type": "object",
"properties": {
"text": {
"type": "string",
"minLength": 1,
"description": "The label text. Supports JQ expressions for dynamic content."
},
"variant": {
"description": "Semantic variant controlling the label color/style.",
"type": "string",
"enum": [
"success",
"alert"
]
}
},
"required": [
"text"
]
},
"workflowStatusLabel": {
"description": "A custom status label to display on the parent workflow run. Overrides any label set by the node configuration. Pass null to clear an existing label.",
"nullable": true,
"type": "object",
"properties": {
"text": {
"type": "string",
"minLength": 1,
"description": "The label text. Supports JQ expressions for dynamic content."
},
"variant": {
"description": "Semantic variant controlling the label color/style.",
"type": "string",
"enum": [
"success",
"alert"
]
}
},
"required": [
"text"
]
},
"reauthRequired": {
"description": "When true, the integration signals that a new OAuth token is needed for this node run.",
"type": "boolean"
}
}
}
}
}
}
}Responses
- 200
- 404
- 409
- 422
- 500
Default Response
Default Response
Default Response
Default Response
Default Response
Responses (JSON)
{
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
}
},
"404": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"ok",
"error"
],
"additionalProperties": false,
"title": "serverError"
}
}
}
},
"409": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"ok",
"error"
],
"additionalProperties": false,
"title": "serverError"
}
}
}
},
"422": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"ok",
"error"
],
"additionalProperties": false,
"title": "serverError"
}
}
}
},
"500": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"ok",
"error"
],
"additionalProperties": false,
"title": "serverError"
}
}
}
}
}
}