value-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.

patch/value-metrics/{slug}

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/value-metrics/{slug}
  • Auth: HTTP bearer

Path parameters

slugstring required

Request body

namestring
variablesobject

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.

archivedAtstring date-time nullable

Set null to restore an archived metric.

category'hve' | 'time' | 'cost' | 'revenue' | 'risk'

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

descriptionstring nullable

Short customer-facing copy shown on value receipts.

longDescriptionstring nullable
expectedActiveVersioninteger

Response

200

slugstring required
namestring required
versioninteger required

The value model version this write published.

Changes

No recorded changes to this operation across all 1 revision of this API.