Skip to main content
PUT
Update conversation

Authorizations

Authorization
string
header
required

Token JWT de autenticação

Headers

x-company-id
string

Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.

Path Parameters

id
string
required

Conversation ID

Body

application/json
additional_attributes
object

Additional conversation attributes (key-value)

custom_attributes
object

System attributes (linked deal, etc.)

who_answering
enum<string>

Who is responding (AGENT/HUMAN)

Available options:
AGENT,
HUMAN,
UNASSIGNED
agent
string

Agent ID

current_step_slug
string

Slug of the current step

current_step
string

ID of the flow's current step

requires_attention
object | null

Attention required

contact_last_activity_at
string

Date of the contact's last activity

last_activity_at
string

Date of the last activity

allow_send_messages_at
string

Date until which messages can be sent (WhatsApp 24h window)

referral
object

Conversation referral data (ads, posts)

status
string

Conversation status

custom_fields
object

Updates custom field values on the conversation, by slug. Covers select/multi_select (value = option_id, or a list of them) and text (value = the string). For number/date, use additional_attributes, which preserves the native type. Atomic validation: an invalid value writes no field and returns 422. The option_id values come from GET /v1/custom-fields/{id}/options.

resume
string

Conversation summary generated by the specialist

temperature
enum<string>

Sales temperature classified by the specialist

Available options:
HOT,
WARM,
COLD,
CLOSED
sentiment
enum<string>

Sentiment classified by the specialist

Available options:
POSITIVE,
NEUTRAL,
NEGATIVE
qualification
object

BANT/GPCT/MEDDIC qualification (specialist)

lead_score
number

Lead score 0-100 based on qualification + ICP

Required range: 0 <= x <= 100
safety_scores
object

Safety scores (prompt injection, hallucination, etc.)

Response

Conversation updated successfully

last_activity_at
any
required

Date of the last activity

status
enum<string>
required

Conversation status

Available options:
OPEN,
RESOLVED
who_answering
enum<string>
required

Who is responding (AGENT/HUMAN)

Available options:
AGENT,
HUMAN,
UNASSIGNED
contact
any
required

Conversation's contact

inbox
any
required

Conversation's inbox

company
any
required

Conversation's company

_id
string

Conversation ID

additional_attributes
any

Additional conversation attributes

agent_last_activity_at
any

Date of the agent's last activity

contact_last_activity_at
any

Date of the contact's last activity

allow_send_messages_at
any

Date allowed to send messages

priority
enum<number>

Conversation priority

Available options:
4,
3,
2,
1
agent
any

Agent assigned to the conversation

current_step
any

Current step of the agent's flow

user
any

User assigned to the conversation

requires_attention
object

Attention required

referral
any

Conversation referral data

createdAt
any

Conversation creation date

updatedAt
any

Conversation update date

resolved_count
number

Number of resolved conversations for the contact (only when grouped)