Create discussion/task conversation

Create a new conversation of type discussion or task. Both types only support comments. If you want to create a conversation that supports messages, use the Create message endpoint. If you want to add a comment to an existing conversation, use the Add comment endpoint.

Required scope: conversations:write

Body Params
string
enum
required

Conversation type

Allowed:
string

Inbox ID for the conversation. Either inbox_id OR teammate_ids must be provided (not both).

teammate_ids
array of strings

Teammates to add to the conversation. Either inbox_id OR teammate_ids must be provided (not both).

teammate_ids
string
required

Subject of the conversation. Used as the title for tasks.

comment
object

Details for the starter comment. Required for discussions, optional for tasks.

string
length ≤ 65535

Description of the task. Only allowed when type is task.

custom_fields
object

Custom fields for this conversation

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Choose an example:
application/json