v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB

Conversation

Update Conversation

Update an existing conversation

patch/conversation

Query parameters

selectstring

Select columns to return

idstring required

Conversation ID

created_atstring

Conversation creation date

updated_atstring

Latest update

organisation_idstring

Organisation ID

subjectstring

Subject of conversation

statusstring

Status of conversation

assignee_idstring

Assignee ID

unreadstring

Is conversation on unread?

channel_idstring

Channel ID

channel_typestring

Channel Type of Conversation

contact_idstring

Contact ID

external_idstring

External ID

tagsstring

Given tags of conversation

is_spamstring

Is conversation marked as spam?

inbox_idstring

Inbox ID

latest_message_idstring

Latest message ID

latest_inbound_message_idstring

Latest inbound message ID

latest_message_created_atstring

Latest message creation date

latest_inbound_message_created_atstring

Latest inbound message creation date

Request body

inbox_idstring uuid

Inbox ID

assignee_idstring uuid nullable

Assignee ID

status'open' | 'closed' | 'archived' public.conversation_status

Status of conversation

Response

The updated Conversation object

idstring uuid

Conversation ID

created_atstring timestamp with time zone

Conversation creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

subjectstring text nullable

Subject of conversation

status'open' | 'closed' | 'archived' public.conversation_status

Status of conversation

assignee_idstring uuid nullable

Assignee ID

unreadboolean nullable

Is conversation on unread?

channel_idstring uuid

Channel ID

Channel Type of Conversation

contact_idstring uuid nullable

Contact ID

external_idstring text nullable

External ID

tagsobject nullable

Given tags of conversation

is_spamboolean

Is conversation marked as spam?

inbox_idstring uuid

Inbox ID

latest_message_idstring uuid nullable

Latest message ID

latest_inbound_message_idstring uuid nullable

Latest inbound message ID

latest_message_created_atstring timestamp with time zone nullable

Latest message creation date

latest_inbound_message_created_atstring timestamp with time zone nullable

Latest inbound message creation date