Remove recipients from conversation
Remove participants from a group conversation, a downline conversation, or a channel. Any participant can remove members from a group or downline conversation; only company admins can remove members from a channel. Other conversation types return 403. The remaining participants see who was removed. Returns 400 if none of recipient_ids are participants. Callable by a signed-in company admin or rep whose role includes the messaging update permission.
Authorizations
Bearer token authentication
Path Parameters
Body
IDs of recipients to remove
Response
The conversation after the participants were removed.
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.
The conversation type, for example GroupConversation.
The short conversation kind (direct, group, channel, or downline), or null for SMS, email, and bot conversations.
One of initiated, open, archived, or closed. A new conversation stays initiated until its first message.
internal for conversations between company members, external for conversations with contacts.
Whether the acting recipient can post in the conversation.
The acting recipient's unsent draft in this conversation, or null.
The recipient who created a conversation.