POST
/
v2
/
agents
/
{agent_id}
/
convos
/
{convo_id}

Authorizations

Authorization
string
headerrequired

Agent/Workspace secret API key as bearer token.

Path Parameters

agent_id
string
required

The ID of the agent to add the conversation to

convo_id
string
required

The ID of the conversation to add

Body

application/json
ID
string

ID of the conversation.

userID
string

User ID.

userName
string

User's name.

userEmail
string

User's email address.

userImage
string

URL to user's profile image.

userPhone
string

User's phone number.

userBrowser
string

User's browser information.

userProfilePic
string

URL to user's profile picture.

origin
enum<string>

Channel origin of the message.

Available options:
web-chat,
whatsapp,
discord,
gb-chat
messagesNum
integer

Number of messages in the conversation.

interactionsNum
integer

Number of interactions in the conversation.

ts
number

Timestamp of the conversation.

tags
string[]

Tags associated with the conversation.

convoTimeSeconds
integer

Duration of the conversation in seconds.

firstMessageTS
number

Timestamp of the first message.

lastMessageTS
number

Timestamp of the last message.

userPlatform
string

User's platform (e.g., mobile, desktop).

state
enum<string>

Type of action to perform, launch type doesn't require a payload

Available options:
requested_chat,
human-chatting,
ai-chatting,
ended_chat
chatAssignedTo
string

ID of the human agent (client_id) assigned to the conversation.

lastModified
number

Timestamp of the last modification.

sessionsNum
integer

Number of sessions in the conversation.

Response

200 - application/json
success
boolean
message
string