Skip to main content
PUT
Update a conversation

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

id
string
required

Body

application/json
conversation
object
required

Response

The updated conversation.

A conversation as seen by the acting recipient. Per-recipient fields such as unread, pinned, and muted describe that recipient's view of the conversation. recipients lists at most six active participants; total_recipients is the full count.

id
integer | null
required
type
string
required

The conversation type, for example GroupConversation.

kind
string | null
required

The short conversation kind (direct, group, channel, or downline), or null for SMS, email, and bot conversations.

name
string | null
required
description
string | null
required
status
string | null
required

One of initiated, open, archived, or closed. A new conversation stays initiated until its first message.

conversation_type
string | null
required

internal for conversations between company members, external for conversations with contacts.

broadcasting
boolean | null
required
auto_add_recipients
boolean | null
required
announcing
boolean | null
required
avatar_background_color
string | null
required
avatar_emoji
string | null
required
avatar_url
string | null
required
image_url
string | null
required
created_at
string<date-time> | null
required
pinned_messages_count
integer | null
required
total_recipients
integer | null
required
unread
boolean | null
required
pinned
boolean | null
required
muted
boolean | null
required
unread_messages_count
integer | null
required
scheduled_messages_count
integer | null
required
email_enabled?
boolean | null
required
sms_enabled?
boolean | null
required
messaging_enabled?
boolean | null
required

Whether the acting recipient can post in the conversation.

draft_message
object | null
required

The acting recipient's unsent draft in this conversation, or null.

recipients
object[]
required
creator
object | null
required

The recipient who created a conversation.