Create Conversation

POST

Creates a conversation.

Request

This endpoint expects an object.
typeenumRequired
Allowed values: support
custom_schema_specobjectRequired

Custom schemas described using identifiers. Each custom field in the request must have the corresponding schema specified; omission results in a Bad Request error. If a custom schema is not included in the specifier, it remains unchanged. For surfaces with human interactors, it is recommended to provide tenant_fragment: true and validate_required_fields: true.

metadataobjectRequired
stageobjectRequired

Sets an object’s initial stage.

custom_fieldsobjectOptional

Application-defined custom fields.

descriptionstringOptionalformat: "text"

Description for the conversation.

groupstringOptionalformat: "id"

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.

owned_bylist of stringsOptional

The users that own the conversation.

source_channelstringOptionalformat: "text"

Whether the conversation is from a source channel.

tagslist of objectsOptional

Tags associated with the conversation.

titlestringOptionalformat: "text"

The title for the conversation.

user_sessionslist of stringsOptional

The IDs of user sessions associated with the conversation.

Response

The response to creating a new conversation.

conversationobject
Built with