Skip to main content
Update the editable subset of a custom metric definition, addressed by its UUID or its stable slug. Only the supplied fields are changed; omitted fields are left unchanged. Every update creates a new immutable version; the response carries the advanced versionId. Immutable fields (scope, outputType, calcType, …) are rejected, and which fields are editable depends on the metric (e.g. derived metrics only allow name). Roark’s own metrics are rejected here: this endpoint edits the shared definition, which every workspace sees. To change one for your workspace alone, edit its variant with PUT /v1/metric/definitions/{idOrSlug}/variants/{variantId}, which forks it for you and leaves every other workspace on the original.
Calls PUT /v1/metric/definitions/{idOrSlug}

Arguments

string
required
The metric definition’s Roark ID (UUID) or its stable slug (e.g. customer_satisfaction).

Options

string
New name (only for metrics whose name is editable).
string
New LLM prompt (only for LLM_JUDGE metrics whose prompt is editable).
integer
New scale minimum (SCALE output only).
integer
New scale maximum (SCALE output only).
array
Replacement set of scale-range labels (SCALE output only).
string
New label for the true case (BOOLEAN output only).
string
New label for the false case (BOOLEAN output only).
array
Replacement set of classification options (CLASSIFICATION output only).
integer
New maximum number of classifications (CLASSIFICATION output only).
array
Replacement set of scoped tool-definition ids (only for metrics whose tool scoping is editable). Repeatable.
array
Replacement set of supported contexts. Omit to leave unchanged. Scope and participantRole cannot change after create, so moving to SEGMENT or TURN grading only works on a PER_PARTICIPANT metric (see create). One of CALL, SEGMENT, TURN Repeatable.
string
New formula expression (FORMULA only). Pass sources alongside if the referenced metrics change.
array
Replacement formula sources, required when formula changes the referenced metrics (FORMULA only).
string
Optional free-text audit note recorded on the new version.
string
string
string
string
string
string
string
string
string
string
string

Example

Every command also takes the global options and sets one of the exit codes.