---
title: "Set Booking Intent Definition"
method: PUT
path: "/api/v1/custom-metrics/{metric_id}/booking-intent-definition"
tags: ["custom-metrics"]
---

# Set Booking Intent Definition

`PUT /api/v1/custom-metrics/{metric_id}/booking-intent-definition`

Designate (or un-designate) this metric as the Booking Intent classifier.

This ONLY flips the ``booking_intent_classifier`` tag — it does NOT create a
new revision (so a metric's evaluation history and results are untouched).
When setting, the tag is cleared from every other tenant metric first, so at
most one metric is the definition at a time.

Only a binary (Yes/No or Pass/Fail) MODEL metric can be the classifier — that's
the shape the post-call stamping reads.

## Path parameters

- `metric_id` string, uuid, required

## Request body

- BookingIntentDefinitionUpdate — Body for the designation endpoint: set/clear the Booking Intent classifier.
  - `is_definition` boolean, required

## Response `200`

Successful Response

- CustomMetricRead
  - `id` string, uuid, required
  - `name` string, required
  - `description` string, nullable, required
  - `category` string, nullable, required
  - `source_template_key` string, nullable, required
  - `compute_type` 'model' | 'formula', required
  - `response_type` 'pass_fail' | 'yes_no' | 'numeric_score' | 'categorical' | 'text' | 'json', required
  - `status` 'active' | 'archived', required
  - `tags` string[], required
  - `active_revision_id` string, uuid, nullable, required
  - `linked_agent_ids` string[], required
  - `applies_to_voice` boolean, required
  - `applies_to_text` boolean, required
  - `applies_to_email` boolean, required
  - `applies_to_booking` boolean, required
  - `creates_action_items` boolean, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `is_booking_intent_definition` boolean, required — True when this metric is the tenant's Booking Intent classifier. Derived from the tag so the frontend never hardcodes the magic string. Set/cleared only via the dedicated designation endpoint.

## Other responses

- `401` — Authentication required
- `404` — Custom metric not found
- `422` — Validation error

## Changes

- **2026-09-15** `41c5e4645524` — 1 info
  - added the required property `creates_action_items` to the response with the `200` status

[Change history](https://skmtc.dev/getanana/apis/cleon-api/changes/api/v1/custom-metrics/:metric_id/booking-intent-definition/put.md)

---

[API](https://skmtc.dev/getanana/apis/cleon-api.md) · [All operations](https://skmtc.dev/getanana/apis/cleon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/getanana/apis/cleon-api/revisions/41c5e4645524?raw)