Workflow Endpoints
Update WorkflowRun
Workflow Endpoints
Update WorkflowRun
You can update the name and metadata of an in progress WorkflowRun at any time using this endpoint.
Parameters
id
string
The ID of the WorkflowRun that was outputted after you created it using the /workflow_runs endpoint.
Body
name
string
An optional name that can be assigned to a specific WorkflowRun.
metadata
any
A metadata object that can be assigned to a specific WorkflowRun. If metadata already exists on the WorkflowRun, this new metadata object will be merged with it, with the new metadata taking field precedence.
Response
workflowRun
WorkflowRun
An object representing a WorkflowRun.
See the WorkflowRun object for the shape of the data.
Workflow
object