{"command":{"effect":"write","timeoutSeconds":30,"inputSchema":{"type":"object","description":"Update a custom metric with the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `15/d`\n\n**Scopes:**\n`metrics:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_custom_metric.json)","properties":{"path":{"type":"object","properties":{"id":{"description":"The ID of the custom metric","type":"string","examples":["925e385b52fb405715f3616c337cc65c"]}},"required":["id"],"additionalProperties":false},"query":{"type":"object","properties":{"fields[custom-metric]":{"type":"array","items":{"type":"string","enum":["created","definition","definition.aggregation_method","definition.metric_groups","id","name","updated"]},"description":"For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets"}},"required":[],"additionalProperties":false},"headers":{"type":"object","properties":{"revision":{"type":"string","default":"2026-10-15","enum":["2026-10-15"],"description":"API endpoint revision (format: YYYY-MM-DD[.suffix])"}},"required":["revision"],"additionalProperties":false},"body":{"$ref":"#/definitions/CustomMetricPartialUpdateQuery"}},"required":["path","headers","body"],"additionalProperties":false,"definitions":{"CustomMetricPartialUpdateQuery":{"type":"object","properties":{"data":{"$ref":"#/definitions/CustomMetricPartialUpdateQueryResourceObject"}},"required":["data"]},"CustomMetricPartialUpdateQueryResourceObject":{"type":"object","properties":{"type":{"$ref":"#/definitions/CustomMetricEnum"},"id":{"description":"The ID of the custom metric","type":"string","examples":["925e385b52fb405715f3616c337cc65c"]},"attributes":{"type":"object","properties":{"name":{"description":"The name for this custom metric. Names must be unique across the account.         Attempting to create a metric with a duplicate name will return a 400 status code.","type":["string","null"],"examples":["My custom metric"]},"definition":{"$ref":"#/definitions/CustomMetricDefinition"}}}},"required":["type","id","attributes"]},"CustomMetricEnum":{"type":"string","enum":["custom-metric"]},"CustomMetricDefinition":{"type":"object","properties":{"aggregation_method":{"description":"Method of aggregation for custom metric measurements. If a metric has a `value` aggregation method, it will be treated as a revenue metric, such as a Placed Order metric. If a metric has a `count` aggregation method, it will only be able to report on conversions like an Active on Site metric.\n","type":"string","enum":["count","value"]},"metric_groups":{"type":"array","items":{"$ref":"#/definitions/CustomMetricGroup"}}},"required":["aggregation_method","metric_groups"]},"CustomMetricGroup":{"type":"object","properties":{"metric_id":{"description":"The ID of the metric that composes the custom metric.","type":"string"},"metric_filters":{"description":"An optional array of objects for filtering on properties of the metric.","type":["array","null"],"items":{"$ref":"#/definitions/CustomMetricCondition"}},"value_property":{"description":"\nIf the custom metric has a `value` aggregation method, the `value_property` of each `metric_group` of the `definition` should specify the property to calculate the conversion value. If null, the default `$value` property will be used.\n","type":["string","null"]}},"required":["metric_id"]},"CustomMetricCondition":{"type":"object","properties":{"property":{"type":"string"},"filter":{"oneOf":[{"$ref":"#/definitions/NumericOperatorNumericFilter"},{"$ref":"#/definitions/StringInArrayFilter"},{"$ref":"#/definitions/ExistenceOperatorExistenceFilter"},{"$ref":"#/definitions/BooleanFilter"},{"$ref":"#/definitions/StringOperatorStringFilter"},{"$ref":"#/definitions/ListContainsOperatorListContainsFilter"},{"$ref":"#/definitions/ListRegexOperatorListContainsFilter"},{"$ref":"#/definitions/ListSubstringFilter"}]}},"required":["property","filter"]},"NumericOperatorNumericFilter":{"type":"object","properties":{"type":{"type":"string","enum":["numeric"]},"operator":{"description":"Operators for numeric filters.","type":"string","enum":["equals","greater-than","greater-than-or-equal","less-than","less-than-or-equal","not-equals"]},"value":{"oneOf":[{"type":"integer"},{"type":"number"}]}},"required":["type","operator","value"]},"StringInArrayFilter":{"type":"object","properties":{"operator":{"type":"string","enum":["in"]},"value":{"type":"array","items":{"type":"string"}},"type":{"type":"string","enum":["string"]}},"required":["operator","value","type"]},"ExistenceOperatorExistenceFilter":{"type":"object","properties":{"type":{"type":"string","enum":["existence"]},"operator":{"description":"Operators for existence filters.","type":"string","enum":["is-set","not-set"]}},"required":["type","operator"]},"BooleanFilter":{"type":"object","properties":{"type":{"type":"string","enum":["boolean"]},"operator":{"description":"Operators for boolean filters.","type":"string","enum":["equals"]},"value":{"type":"boolean"}},"required":["type","operator","value"]},"StringOperatorStringFilter":{"type":"object","properties":{"type":{"type":"string","enum":["string"]},"operator":{"description":"Operators for string filters.","type":"string","enum":["contains","ends-with","equals","not-contains","not-ends-with","not-equals","not-starts-with","nregex","regex","starts-with"]},"value":{"type":["string","null"]}},"required":["type","operator","value"]},"ListContainsOperatorListContainsFilter":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"operator":{"description":"Operators for list contains filters.","type":"string","enum":["contains","not-contains"]},"value":{"oneOf":[{"type":"integer"},{"type":"string"}]}},"required":["type","operator","value"]},"ListRegexOperatorListContainsFilter":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"operator":{"description":"Operators for list regex filters.","type":"string","enum":["contains-ends-with","contains-starts-with","not-contains-ends-with","not-contains-starts-with"]},"value":{"oneOf":[{"type":"integer"},{"type":"string"}]}},"required":["type","operator","value"]},"ListSubstringFilter":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"operator":{"description":"Operators for list substring filters.","type":"string","enum":["contains-substring","not-contains-substring"]},"value":{"type":["string","null"]}},"required":["type","operator","value"]}}},"name":"Update Custom Metric","id":"klaviyo.update_custom_metric","example":{"path":{"id":"925e385b52fb405715f3616c337cc65c"},"headers":{"revision":"2026-10-15"},"body":{"data":{"type":"custom-metric","id":"925e385b52fb405715f3616c337cc65c","attributes":{}}}},"maxRequests":1,"summary":false}}