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

Authorizations

Authorization
string
header
required

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
chatAssignedTo
string

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

convoTimeSeconds
integer

Duration of the conversation in seconds.

firstMessageTS
number

Timestamp of the first message.

ID
string

ID of the conversation.

interactionsNum
integer

Number of interactions in the conversation.

lastMessageTS
number

Timestamp of the last message.

lastModified
number

Timestamp of the last modification.

messagesNum
integer

Number of messages in the conversation.

origin
enum<string>

Channel origin of the message.

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

Number of sessions in the conversation.

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
tags
string[]

Tags associated with the conversation.

ts
number

Timestamp of the conversation.

userBrowser
string

User's browser information.

userEmail
string

User's email address.

userID
string

User ID.

userImage
string

URL to user's profile image.

userName
string

User's name.

userPhone
string

User's phone number.

userPlatform
string

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

userProfilePic
string

URL to user's profile picture.

Response

200 - application/json
message
string
success
boolean