Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
LeadLabel

Test AI reply label prediction

Returns the AI-predicted lead label for a reply text. This simulates how AI auto-tagging would label an incoming reply for testing custom labels and descriptions. Rate limit: 500 requests per 30 days per workspace. This rate limit applies only to this testing endpoint; live reply processing does not use this limiter.

Requires one of the following scopes: lead-labels:read, lead-labels:all, all:read, all:all

post/api/v2/lead-labels/ai-reply-label

Request body

reply_textstring required

The reply text to classify.

Example request

{
  "reply_text": "Thanks for reaching out. I am interested in learning more."
}

Response

Default Response

resultstring

The predicted lead label.

custom_labels_consideredstring[]

AI-enabled custom labels considered during classification.

Example response

{
  "result": "Hot Lead",
  "custom_labels_considered": [
    "Hot Lead",
    "Needs Follow-up"
  ]
}