POST
/
api
/
conversation
/
new

​
Body

​
slug
string

The slug of the clone that you want to start a new conversation with

​
instance_slug
string

Optionally, the slug of the clone instance that you want to start a new conversation with. This should be used in addition to the slug of the clone

​
user_email
string

The email of the user chatting with the clone.

Include this field to personalize the conversation to a user. Read more on the Personalization page

​
Response

​
new
object

Metadata about the new conversation that was just created

​
conversation_id
uuid

The id of the conversation. Store in a safe place to be passed in for generating clone responses. Learn more on the Generate Response page

​
created_at
datetime

The UTC timestamp of when the conversation was created

​
messages
Message array

An array containing the opening message from the clone. Customize the clone’s opening message on the Train tab of the clone editing page.

​
text
string

The text of the opening message

​
created_at
string

The time the message was sent

​
sender
string

Who sent the message. Either CLONE or USER

​
conversation_type
string

The type of the conversation, either: anonymous No user email was included in the request, no user information will be used to generate clone responses for this conversation personalized User email was included, conversation will be personal to the user

Was this page helpful?