Map a role to a metric or custom metric
https://email.growthdept.ai/api/mapped-metrics/{id}Set relationships.metric or relationships.custom-metric; null clears the role, which then falls back to the metric with the conventional name.
The request body can be up to 5 MB.
Rate limits
Scopes
metrics:write
Operation id
update_mapped_metric The same operation as in Klaviyo's API. OpenAPI document
Path parameters
stringrequired
Query parameters
Pick values to add them to the request:
Body
Send application/vnd.api+json or application/json.
object
dataobjectrequired
data: 4 fields
typestringrequired
mapped-metricidstringrequired
added_to_cartcancelled_salesordered_productrefunded_salesrevenuestarted_checkoutviewed_productattributesobject
relationshipsobject
relationships: 2 fields
metricobject
metric: 1 field
dataobjectrequired
data: 2 fields
typestringrequired
metricidstringrequired
custom-metricobject
custom-metric: 1 field
dataobjectrequired
data: 2 fields
typestringrequired
custom-metricidstringrequired
Edit the example. The code samples use what you type here.
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
200Success
Response body
object
dataobjectrequired
data: 5 fields
typestringrequired
mapped-metricidstringrequired
added_to_cartcancelled_salesordered_productrefunded_salesrevenuestarted_checkoutviewed_productattributesobjectrequired
attributes: 1 field
updatedstring (date-time)required
relationshipsobject
relationships: 2 fields
metricobject
metric: 2 fields
dataobject
data: 2 fields
typestringrequired
metricidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
custom-metricobject
custom-metric: 2 fields
dataobject
data: 2 fields
typestringrequired
custom-metricidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
linksobject
links: 1 field
selfstring (uri)required
metaobject
4XXClient error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject
See status codes for each code.
5XXServer error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject