Skip to main content
PATCH
Update a Lead Insight

Authorizations

X-API-Key
string
header
required

API key for programmatic access (format nl_live_* or nl_test_*)

Path Parameters

id
string
required

MongoDB ObjectId of the preference document.

Body

application/json

Partial update. At least one of topic, preference, or confidence must be provided.

topic
string
Maximum string length: 100
preference
string
Maximum string length: 200
confidence
enum<string>
Available options:
high,
medium,
low

Response

Updated insight.

A single extracted lead insight (preference). Unique per (accountId, leadId, topic) — updates overwrite the same topic.

_id
string
required

Preference document id.

leadId
string
required

Lead id these insights belong to.

topic
string
required

Preference domain (e.g. budget, timeline, location).

Maximum string length: 100
preference
string
required

Extracted value for the topic.

Maximum string length: 200
confidence
enum<string>
required

Model confidence in the extraction.

Available options:
high,
medium,
low
accountId
string

Owning account id.

conversationId
string

Conversation that last wrote or updated this insight.

source
string

Short snippet or provenance of the extraction.

createdAt
string<date-time>
updatedAt
string<date-time>
expiresAt
string<date-time>

TTL expiry (default ~90 days from last write).