Update Conversation
curl --request PUT \
--url https://api.chat-dash.com/v1/public/agents/{agentId}/conversations/{conversationId} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"platformId": "<string>",
"leadId": "<string>",
"name": "<string>",
"read": false,
"endedAt": "2023-11-07T05:31:56Z",
"browser": "<string>",
"device": "<string>",
"os": "<string>",
"countryCode": "<string>",
"ipAddress": "<string>",
"record": false,
"interacted": false,
"channel": "<string>",
"phone": "<string>",
"phoneSecondary": "<string>",
"instagramId": "<string>",
"instagramUsername": "<string>",
"cost": 123,
"duration": 123,
"url": "<string>",
"endedReason": "<string>",
"noAnswer": true,
"status": "ai",
"liveAgentName": "<string>",
"liveAgentId": "<string>",
"isLive": false,
"note": "<string>",
"topic": "<string>",
"subtopic": "<string>",
"summary": "<string>",
"evaluation": {
"isSuccess": true,
"reason": "<string>"
},
"mistunderstoodQueries": [
{
"question": "<string>"
}
],
"customAnalysis": {},
"metadata": {}
}
'import requests
url = "https://api.chat-dash.com/v1/public/agents/{agentId}/conversations/{conversationId}"
payload = {
"platformId": "<string>",
"leadId": "<string>",
"name": "<string>",
"read": False,
"endedAt": "2023-11-07T05:31:56Z",
"browser": "<string>",
"device": "<string>",
"os": "<string>",
"countryCode": "<string>",
"ipAddress": "<string>",
"record": False,
"interacted": False,
"channel": "<string>",
"phone": "<string>",
"phoneSecondary": "<string>",
"instagramId": "<string>",
"instagramUsername": "<string>",
"cost": 123,
"duration": 123,
"url": "<string>",
"endedReason": "<string>",
"noAnswer": True,
"status": "ai",
"liveAgentName": "<string>",
"liveAgentId": "<string>",
"isLive": False,
"note": "<string>",
"topic": "<string>",
"subtopic": "<string>",
"summary": "<string>",
"evaluation": {
"isSuccess": True,
"reason": "<string>"
},
"mistunderstoodQueries": [{ "question": "<string>" }],
"customAnalysis": {},
"metadata": {}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
platformId: '<string>',
leadId: '<string>',
name: '<string>',
read: false,
endedAt: '2023-11-07T05:31:56Z',
browser: '<string>',
device: '<string>',
os: '<string>',
countryCode: '<string>',
ipAddress: '<string>',
record: false,
interacted: false,
channel: '<string>',
phone: '<string>',
phoneSecondary: '<string>',
instagramId: '<string>',
instagramUsername: '<string>',
cost: 123,
duration: 123,
url: '<string>',
endedReason: '<string>',
noAnswer: true,
status: 'ai',
liveAgentName: '<string>',
liveAgentId: '<string>',
isLive: false,
note: '<string>',
topic: '<string>',
subtopic: '<string>',
summary: '<string>',
evaluation: {isSuccess: true, reason: '<string>'},
mistunderstoodQueries: [{question: '<string>'}],
customAnalysis: {},
metadata: {}
})
};
fetch('https://api.chat-dash.com/v1/public/agents/{agentId}/conversations/{conversationId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.chat-dash.com/v1/public/agents/{agentId}/conversations/{conversationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'platformId' => '<string>',
'leadId' => '<string>',
'name' => '<string>',
'read' => false,
'endedAt' => '2023-11-07T05:31:56Z',
'browser' => '<string>',
'device' => '<string>',
'os' => '<string>',
'countryCode' => '<string>',
'ipAddress' => '<string>',
'record' => false,
'interacted' => false,
'channel' => '<string>',
'phone' => '<string>',
'phoneSecondary' => '<string>',
'instagramId' => '<string>',
'instagramUsername' => '<string>',
'cost' => 123,
'duration' => 123,
'url' => '<string>',
'endedReason' => '<string>',
'noAnswer' => true,
'status' => 'ai',
'liveAgentName' => '<string>',
'liveAgentId' => '<string>',
'isLive' => false,
'note' => '<string>',
'topic' => '<string>',
'subtopic' => '<string>',
'summary' => '<string>',
'evaluation' => [
'isSuccess' => true,
'reason' => '<string>'
],
'mistunderstoodQueries' => [
[
'question' => '<string>'
]
],
'customAnalysis' => [
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.chat-dash.com/v1/public/agents/{agentId}/conversations/{conversationId}"
payload := strings.NewReader("{\n \"platformId\": \"<string>\",\n \"leadId\": \"<string>\",\n \"name\": \"<string>\",\n \"read\": false,\n \"endedAt\": \"2023-11-07T05:31:56Z\",\n \"browser\": \"<string>\",\n \"device\": \"<string>\",\n \"os\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"record\": false,\n \"interacted\": false,\n \"channel\": \"<string>\",\n \"phone\": \"<string>\",\n \"phoneSecondary\": \"<string>\",\n \"instagramId\": \"<string>\",\n \"instagramUsername\": \"<string>\",\n \"cost\": 123,\n \"duration\": 123,\n \"url\": \"<string>\",\n \"endedReason\": \"<string>\",\n \"noAnswer\": true,\n \"status\": \"ai\",\n \"liveAgentName\": \"<string>\",\n \"liveAgentId\": \"<string>\",\n \"isLive\": false,\n \"note\": \"<string>\",\n \"topic\": \"<string>\",\n \"subtopic\": \"<string>\",\n \"summary\": \"<string>\",\n \"evaluation\": {\n \"isSuccess\": true,\n \"reason\": \"<string>\"\n },\n \"mistunderstoodQueries\": [\n {\n \"question\": \"<string>\"\n }\n ],\n \"customAnalysis\": {},\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.chat-dash.com/v1/public/agents/{agentId}/conversations/{conversationId}")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"platformId\": \"<string>\",\n \"leadId\": \"<string>\",\n \"name\": \"<string>\",\n \"read\": false,\n \"endedAt\": \"2023-11-07T05:31:56Z\",\n \"browser\": \"<string>\",\n \"device\": \"<string>\",\n \"os\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"record\": false,\n \"interacted\": false,\n \"channel\": \"<string>\",\n \"phone\": \"<string>\",\n \"phoneSecondary\": \"<string>\",\n \"instagramId\": \"<string>\",\n \"instagramUsername\": \"<string>\",\n \"cost\": 123,\n \"duration\": 123,\n \"url\": \"<string>\",\n \"endedReason\": \"<string>\",\n \"noAnswer\": true,\n \"status\": \"ai\",\n \"liveAgentName\": \"<string>\",\n \"liveAgentId\": \"<string>\",\n \"isLive\": false,\n \"note\": \"<string>\",\n \"topic\": \"<string>\",\n \"subtopic\": \"<string>\",\n \"summary\": \"<string>\",\n \"evaluation\": {\n \"isSuccess\": true,\n \"reason\": \"<string>\"\n },\n \"mistunderstoodQueries\": [\n {\n \"question\": \"<string>\"\n }\n ],\n \"customAnalysis\": {},\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chat-dash.com/v1/public/agents/{agentId}/conversations/{conversationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"platformId\": \"<string>\",\n \"leadId\": \"<string>\",\n \"name\": \"<string>\",\n \"read\": false,\n \"endedAt\": \"2023-11-07T05:31:56Z\",\n \"browser\": \"<string>\",\n \"device\": \"<string>\",\n \"os\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"record\": false,\n \"interacted\": false,\n \"channel\": \"<string>\",\n \"phone\": \"<string>\",\n \"phoneSecondary\": \"<string>\",\n \"instagramId\": \"<string>\",\n \"instagramUsername\": \"<string>\",\n \"cost\": 123,\n \"duration\": 123,\n \"url\": \"<string>\",\n \"endedReason\": \"<string>\",\n \"noAnswer\": true,\n \"status\": \"ai\",\n \"liveAgentName\": \"<string>\",\n \"liveAgentId\": \"<string>\",\n \"isLive\": false,\n \"note\": \"<string>\",\n \"topic\": \"<string>\",\n \"subtopic\": \"<string>\",\n \"summary\": \"<string>\",\n \"evaluation\": {\n \"isSuccess\": true,\n \"reason\": \"<string>\"\n },\n \"mistunderstoodQueries\": [\n {\n \"question\": \"<string>\"\n }\n ],\n \"customAnalysis\": {},\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"message": "Conversation updated successfully"
}{
"error": "An unexpected error occurred"
}Conversations
Update Conversation
Update a conversation’s read, endedAt, record, interacted, and isLive fields
PUT
/
agents
/
{agentId}
/
conversations
/
{conversationId}
Update Conversation
curl --request PUT \
--url https://api.chat-dash.com/v1/public/agents/{agentId}/conversations/{conversationId} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"platformId": "<string>",
"leadId": "<string>",
"name": "<string>",
"read": false,
"endedAt": "2023-11-07T05:31:56Z",
"browser": "<string>",
"device": "<string>",
"os": "<string>",
"countryCode": "<string>",
"ipAddress": "<string>",
"record": false,
"interacted": false,
"channel": "<string>",
"phone": "<string>",
"phoneSecondary": "<string>",
"instagramId": "<string>",
"instagramUsername": "<string>",
"cost": 123,
"duration": 123,
"url": "<string>",
"endedReason": "<string>",
"noAnswer": true,
"status": "ai",
"liveAgentName": "<string>",
"liveAgentId": "<string>",
"isLive": false,
"note": "<string>",
"topic": "<string>",
"subtopic": "<string>",
"summary": "<string>",
"evaluation": {
"isSuccess": true,
"reason": "<string>"
},
"mistunderstoodQueries": [
{
"question": "<string>"
}
],
"customAnalysis": {},
"metadata": {}
}
'import requests
url = "https://api.chat-dash.com/v1/public/agents/{agentId}/conversations/{conversationId}"
payload = {
"platformId": "<string>",
"leadId": "<string>",
"name": "<string>",
"read": False,
"endedAt": "2023-11-07T05:31:56Z",
"browser": "<string>",
"device": "<string>",
"os": "<string>",
"countryCode": "<string>",
"ipAddress": "<string>",
"record": False,
"interacted": False,
"channel": "<string>",
"phone": "<string>",
"phoneSecondary": "<string>",
"instagramId": "<string>",
"instagramUsername": "<string>",
"cost": 123,
"duration": 123,
"url": "<string>",
"endedReason": "<string>",
"noAnswer": True,
"status": "ai",
"liveAgentName": "<string>",
"liveAgentId": "<string>",
"isLive": False,
"note": "<string>",
"topic": "<string>",
"subtopic": "<string>",
"summary": "<string>",
"evaluation": {
"isSuccess": True,
"reason": "<string>"
},
"mistunderstoodQueries": [{ "question": "<string>" }],
"customAnalysis": {},
"metadata": {}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
platformId: '<string>',
leadId: '<string>',
name: '<string>',
read: false,
endedAt: '2023-11-07T05:31:56Z',
browser: '<string>',
device: '<string>',
os: '<string>',
countryCode: '<string>',
ipAddress: '<string>',
record: false,
interacted: false,
channel: '<string>',
phone: '<string>',
phoneSecondary: '<string>',
instagramId: '<string>',
instagramUsername: '<string>',
cost: 123,
duration: 123,
url: '<string>',
endedReason: '<string>',
noAnswer: true,
status: 'ai',
liveAgentName: '<string>',
liveAgentId: '<string>',
isLive: false,
note: '<string>',
topic: '<string>',
subtopic: '<string>',
summary: '<string>',
evaluation: {isSuccess: true, reason: '<string>'},
mistunderstoodQueries: [{question: '<string>'}],
customAnalysis: {},
metadata: {}
})
};
fetch('https://api.chat-dash.com/v1/public/agents/{agentId}/conversations/{conversationId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.chat-dash.com/v1/public/agents/{agentId}/conversations/{conversationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'platformId' => '<string>',
'leadId' => '<string>',
'name' => '<string>',
'read' => false,
'endedAt' => '2023-11-07T05:31:56Z',
'browser' => '<string>',
'device' => '<string>',
'os' => '<string>',
'countryCode' => '<string>',
'ipAddress' => '<string>',
'record' => false,
'interacted' => false,
'channel' => '<string>',
'phone' => '<string>',
'phoneSecondary' => '<string>',
'instagramId' => '<string>',
'instagramUsername' => '<string>',
'cost' => 123,
'duration' => 123,
'url' => '<string>',
'endedReason' => '<string>',
'noAnswer' => true,
'status' => 'ai',
'liveAgentName' => '<string>',
'liveAgentId' => '<string>',
'isLive' => false,
'note' => '<string>',
'topic' => '<string>',
'subtopic' => '<string>',
'summary' => '<string>',
'evaluation' => [
'isSuccess' => true,
'reason' => '<string>'
],
'mistunderstoodQueries' => [
[
'question' => '<string>'
]
],
'customAnalysis' => [
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.chat-dash.com/v1/public/agents/{agentId}/conversations/{conversationId}"
payload := strings.NewReader("{\n \"platformId\": \"<string>\",\n \"leadId\": \"<string>\",\n \"name\": \"<string>\",\n \"read\": false,\n \"endedAt\": \"2023-11-07T05:31:56Z\",\n \"browser\": \"<string>\",\n \"device\": \"<string>\",\n \"os\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"record\": false,\n \"interacted\": false,\n \"channel\": \"<string>\",\n \"phone\": \"<string>\",\n \"phoneSecondary\": \"<string>\",\n \"instagramId\": \"<string>\",\n \"instagramUsername\": \"<string>\",\n \"cost\": 123,\n \"duration\": 123,\n \"url\": \"<string>\",\n \"endedReason\": \"<string>\",\n \"noAnswer\": true,\n \"status\": \"ai\",\n \"liveAgentName\": \"<string>\",\n \"liveAgentId\": \"<string>\",\n \"isLive\": false,\n \"note\": \"<string>\",\n \"topic\": \"<string>\",\n \"subtopic\": \"<string>\",\n \"summary\": \"<string>\",\n \"evaluation\": {\n \"isSuccess\": true,\n \"reason\": \"<string>\"\n },\n \"mistunderstoodQueries\": [\n {\n \"question\": \"<string>\"\n }\n ],\n \"customAnalysis\": {},\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.chat-dash.com/v1/public/agents/{agentId}/conversations/{conversationId}")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"platformId\": \"<string>\",\n \"leadId\": \"<string>\",\n \"name\": \"<string>\",\n \"read\": false,\n \"endedAt\": \"2023-11-07T05:31:56Z\",\n \"browser\": \"<string>\",\n \"device\": \"<string>\",\n \"os\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"record\": false,\n \"interacted\": false,\n \"channel\": \"<string>\",\n \"phone\": \"<string>\",\n \"phoneSecondary\": \"<string>\",\n \"instagramId\": \"<string>\",\n \"instagramUsername\": \"<string>\",\n \"cost\": 123,\n \"duration\": 123,\n \"url\": \"<string>\",\n \"endedReason\": \"<string>\",\n \"noAnswer\": true,\n \"status\": \"ai\",\n \"liveAgentName\": \"<string>\",\n \"liveAgentId\": \"<string>\",\n \"isLive\": false,\n \"note\": \"<string>\",\n \"topic\": \"<string>\",\n \"subtopic\": \"<string>\",\n \"summary\": \"<string>\",\n \"evaluation\": {\n \"isSuccess\": true,\n \"reason\": \"<string>\"\n },\n \"mistunderstoodQueries\": [\n {\n \"question\": \"<string>\"\n }\n ],\n \"customAnalysis\": {},\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chat-dash.com/v1/public/agents/{agentId}/conversations/{conversationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"platformId\": \"<string>\",\n \"leadId\": \"<string>\",\n \"name\": \"<string>\",\n \"read\": false,\n \"endedAt\": \"2023-11-07T05:31:56Z\",\n \"browser\": \"<string>\",\n \"device\": \"<string>\",\n \"os\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"record\": false,\n \"interacted\": false,\n \"channel\": \"<string>\",\n \"phone\": \"<string>\",\n \"phoneSecondary\": \"<string>\",\n \"instagramId\": \"<string>\",\n \"instagramUsername\": \"<string>\",\n \"cost\": 123,\n \"duration\": 123,\n \"url\": \"<string>\",\n \"endedReason\": \"<string>\",\n \"noAnswer\": true,\n \"status\": \"ai\",\n \"liveAgentName\": \"<string>\",\n \"liveAgentId\": \"<string>\",\n \"isLive\": false,\n \"note\": \"<string>\",\n \"topic\": \"<string>\",\n \"subtopic\": \"<string>\",\n \"summary\": \"<string>\",\n \"evaluation\": {\n \"isSuccess\": true,\n \"reason\": \"<string>\"\n },\n \"mistunderstoodQueries\": [\n {\n \"question\": \"<string>\"\n }\n ],\n \"customAnalysis\": {},\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"message": "Conversation updated successfully"
}{
"error": "An unexpected error occurred"
}Headers
All requests to the ChatDash API must be validated with the agency API Key found on your agency profile
Path Parameters
The ID of the agent
The ID of the conversation
Body
application/json
The conversation ID on the original platform
The lead associated with the conversation
The name of the user who created the conversation
Whether the conversation has been read
The date and time the conversation ended
The browser used for the conversation
The device used for the conversation
The operating system used for the conversation
The country code associated with the user's location (ISO 3166-1 alpha-2)
The IP address of the User
Whether to record the conversation
Whether the conversation has user interaction
The channel where the conversation took place
The phone number associated with the conversation (FROM number for Retell, CUSTOMER number for Vapi and ElevenLabs)
The TO phone number for retell, AGENT number for Vapi and ElevenLabs)
The Instagram ID of the user for Instagram conversations
The Instagram username of the user for Instagram conversations
The cost of the conversation (voice ai calls)
The duration of the conversation in minutes (voice ai calls)
The URL of the conversation (recording URL for voice ai)
The reason the conversation ended (voice ai)
If the call was not answered (voice ai)
The status of the conversation
Available options:
ai, pending, human Name of the live agent handling the conversation
ID of the live agent that handled the conversation
Whether the conversation is live
A note about the conversation
The topic associated with the conversation
The subtopic associated with the conversation
Summary of the conversation
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Custom analysis data being imported in from platforms (just voice agents for now)
Metadata associated with the conversation (e.g., custom fields from platforms)
Response
OK
Example:
"Conversation updated successfully"