conversations

Create

POST
Creates a conversation.

Request

This endpoint expects an object.
type
string literalRequired
Allowed value: support
description
stringOptional
Description for the conversation.
group
stringOptional
The group that the conversation is associated with.
is_spam
booleanOptional
Whether the conversation is spam.
members
list of stringsOptional
The users in the conversation.
messages
list of objectsOptional
Initial messages on the conversation.
metadata
objectOptional
source_channel
stringOptional
Whether the conversation is from a source channel.
stage
objectOptional
Sets an object's initial stage.
tags
list of objectsOptional
Tags associated with the conversation.
title
stringOptional
The title for the conversation.
user_sessions
list of stringsOptional
The IDs of user sessions associated with the conversation.

Response

This endpoint returns an object
conversation
object