Skip to main content
PATCH
Update a conversation

Authorizations

Authorization
string
header
required

Your v3 API key, e.g. ask_live_…

Headers

X-Subaccount-Id
string

Target subaccount for the request. Required unless the API key is authorized for exactly one subaccount (then it defaults to that one). Alternatively pass subaccount_id (or legacy location_id) in the request body. Omitting it on a multi-subaccount key returns 400 subaccount_required.

Path Parameters

id
string
required
Minimum string length: 1

Body

application/json
status
string | null
Required string length: 1 - 64
summary
string | null
Maximum string length: 8000
is_archived
boolean
is_favorite
boolean
lead_quality
enum<string> | null

Lead quality: HOT, WARM, COLD, or UNQUALIFIED.

Available options:
HOT,
WARM,
COLD,
UNQUALIFIED
user_sentiment
enum<string> | null

User sentiment: POSITIVE, NEUTRAL, NEGATIVE, or MIXED.

Available options:
POSITIVE,
NEUTRAL,
NEGATIVE,
MIXED
subaccount_id
string

Target subaccount id. Prefer the X-Subaccount-Id header; this body field is a fallback.

location_id
string

Alias for subaccount_id (GHL location id).

Response

Success

data
object
required
request_id
string
required
error
null