Create

POST

Creates a conversation.

Request

This endpoint expects an object.
type"support"Required
custom_fieldsmap from strings to anyOptional

Application-defined custom fields.

custom_schema_specobjectOptional

Requested custom schemas described abstractly. Every provided schema’s custom field must be specified, otherwise a bad request error is returned. If a new custom schema specifier is provided, then it will be added to the work, otherwise if a custom schema is omitted from the specifier, it remains unmodified.

descriptionstringOptional

Description for the conversation.

groupstringOptional

The group that the conversation is associated with.

is_spambooleanOptional

Whether the conversation is spam.

memberslist of stringsOptional

The users in the conversation.

messageslist of objectsOptional

Initial messages on the conversation.

metadataobjectOptional
owned_bylist of stringsOptional

The users that own the conversation.

source_channelstringOptional

Whether the conversation is from a source channel.

stageobjectOptional

Sets an object’s initial stage.

tagslist of objectsOptional

Tags associated with the conversation.

titlestringOptional

The title for the conversation.

user_sessionslist of stringsOptional

The IDs of user sessions associated with the conversation.

Response

This endpoint returns an object.
conversationobject