Skip to navigation
API Referencevalue-metrics

Update a value metric

Changes one value metric. Omitted fields are left alone. You can change its name, category, unit, customer-facing copy, sources, monetary rate, archive state, and the value, label or display format of any variable its formula declares. The formula expression and the signal it is bound to cannot be changed — recreate the metric, or use the whole value-model upload. Publishes a new value model version.

Authentication

AuthorizationBearer
API Key authentication using Bearer token

Path parameters

slugstringRequired>=1 character

Request

Body
namestringOptional1-120 characters
unitobjectOptional
monetaryConversionobjectOptional
variablesmap from strings to objectsOptional

Per-variable edits, keyed by the variable id the formula declares. Merged: a variable you do not name is untouched. Naming one the formula does not declare is an error rather than a no-op.

archivedAtdatetime or nullOptional
Set null to restore an archived metric.
categoryenumOptional

Classification: hve = human value equivalent, time = time saved, cost = cost savings, revenue = revenue generated, risk = risk avoided.

Allowed values:
descriptionstring or nullOptional

Short customer-facing copy shown on value receipts.

longDescriptionstring or nullOptional
sourceslist of objects or nullOptional

Up to 3 customer-facing citations backing this metric.

expectedActiveVersionintegerOptional

Response

200
slugstring
namestring
versioninteger
The value model version this write published.

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error