Skip to main content
PATCH
Rename Run

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

run_id
string
required

Body

application/json

Rename an existing run. The name is the primary identifier in the runs list and the run-detail header.

name
string
required

The new run name.

Required string length: 1 - 200

Response

Successful Response

id
string
required
org_id
string
required
status
string
required
name
string | null
phase
string | null
awaiting_gate
string | null
temporal_workflow_id
string | null
targets_total
integer
default:0
targets_completed
integer
default:0
targets_scored
integer
default:0
targets_errored
integer
default:0
targets_filtered
integer
default:0
outcome_counts
Outcome Counts · object
deliverables
Deliverables · object
report_files
Report Files · object
shortlist_selection
Shortlist Selection · object
cost
Cost · object | null
health
Health · object | null
error
string | null
created_by
string | null
created_at
string | null
updated_at
string | null