Update a conversation
curl --request PATCH \
--url https://api.assistable.ai/v3/conversations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "<string>",
"summary": "<string>",
"is_archived": true,
"is_favorite": true,
"subaccount_id": "<string>",
"location_id": "<string>"
}
'import requests
url = "https://api.assistable.ai/v3/conversations/{id}"
payload = {
"status": "<string>",
"summary": "<string>",
"is_archived": True,
"is_favorite": True,
"subaccount_id": "<string>",
"location_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: '<string>',
summary: '<string>',
is_archived: true,
is_favorite: true,
subaccount_id: '<string>',
location_id: '<string>'
})
};
fetch('https://api.assistable.ai/v3/conversations/{id}', 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.assistable.ai/v3/conversations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => '<string>',
'summary' => '<string>',
'is_archived' => true,
'is_favorite' => true,
'subaccount_id' => '<string>',
'location_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.assistable.ai/v3/conversations/{id}"
payload := strings.NewReader("{\n \"status\": \"<string>\",\n \"summary\": \"<string>\",\n \"is_archived\": true,\n \"is_favorite\": true,\n \"subaccount_id\": \"<string>\",\n \"location_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.assistable.ai/v3/conversations/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"<string>\",\n \"summary\": \"<string>\",\n \"is_archived\": true,\n \"is_favorite\": true,\n \"subaccount_id\": \"<string>\",\n \"location_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assistable.ai/v3/conversations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"<string>\",\n \"summary\": \"<string>\",\n \"is_archived\": true,\n \"is_favorite\": true,\n \"subaccount_id\": \"<string>\",\n \"location_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"contactId": "<string>",
"contactName": "<string>",
"contactEmail": "<string>",
"contactPhone": "<string>",
"previewText": "<string>",
"lastChannel": "<string>",
"conversationType": "<string>",
"aiResponses": 123,
"isArchived": true,
"isFavorite": true,
"leadQuality": "<string>",
"userSentiment": "<string>",
"status": "<string>",
"summary": "<string>",
"assistant": {
"id": "<string>",
"name": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
},
"request_id": "<string>",
"error": null
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"request_id": "<string>",
"data": null
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"request_id": "<string>",
"data": null
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"request_id": "<string>",
"data": null
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"request_id": "<string>",
"data": null
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"request_id": "<string>",
"data": null
}Conversations
Update a conversation
Requires scope conversations:update.
PATCH
/
v3
/
conversations
/
{id}
Update a conversation
curl --request PATCH \
--url https://api.assistable.ai/v3/conversations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "<string>",
"summary": "<string>",
"is_archived": true,
"is_favorite": true,
"subaccount_id": "<string>",
"location_id": "<string>"
}
'import requests
url = "https://api.assistable.ai/v3/conversations/{id}"
payload = {
"status": "<string>",
"summary": "<string>",
"is_archived": True,
"is_favorite": True,
"subaccount_id": "<string>",
"location_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: '<string>',
summary: '<string>',
is_archived: true,
is_favorite: true,
subaccount_id: '<string>',
location_id: '<string>'
})
};
fetch('https://api.assistable.ai/v3/conversations/{id}', 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.assistable.ai/v3/conversations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => '<string>',
'summary' => '<string>',
'is_archived' => true,
'is_favorite' => true,
'subaccount_id' => '<string>',
'location_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.assistable.ai/v3/conversations/{id}"
payload := strings.NewReader("{\n \"status\": \"<string>\",\n \"summary\": \"<string>\",\n \"is_archived\": true,\n \"is_favorite\": true,\n \"subaccount_id\": \"<string>\",\n \"location_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.assistable.ai/v3/conversations/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"<string>\",\n \"summary\": \"<string>\",\n \"is_archived\": true,\n \"is_favorite\": true,\n \"subaccount_id\": \"<string>\",\n \"location_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assistable.ai/v3/conversations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"<string>\",\n \"summary\": \"<string>\",\n \"is_archived\": true,\n \"is_favorite\": true,\n \"subaccount_id\": \"<string>\",\n \"location_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"contactId": "<string>",
"contactName": "<string>",
"contactEmail": "<string>",
"contactPhone": "<string>",
"previewText": "<string>",
"lastChannel": "<string>",
"conversationType": "<string>",
"aiResponses": 123,
"isArchived": true,
"isFavorite": true,
"leadQuality": "<string>",
"userSentiment": "<string>",
"status": "<string>",
"summary": "<string>",
"assistant": {
"id": "<string>",
"name": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
},
"request_id": "<string>",
"error": null
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"request_id": "<string>",
"data": null
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"request_id": "<string>",
"data": null
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"request_id": "<string>",
"data": null
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"request_id": "<string>",
"data": null
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"request_id": "<string>",
"data": null
}Authorizations
Your v3 API key, e.g. ask_live_…
Headers
Target subaccount for the request. Required unless the API key is authorized for exactly one subaccount (then it defaults to that one). Alternatively pass subaccount_id (or legacy location_id) in the request body. Omitting it on a multi-subaccount key returns 400 subaccount_required.
Path Parameters
Minimum string length:
1Body
application/json
Required string length:
1 - 64Maximum string length:
8000Lead quality: HOT, WARM, COLD, or UNQUALIFIED.
Available options:
HOT, WARM, COLD, UNQUALIFIED User sentiment: POSITIVE, NEUTRAL, NEGATIVE, or MIXED.
Available options:
POSITIVE, NEUTRAL, NEGATIVE, MIXED Target subaccount id. Prefer the X-Subaccount-Id header; this body field is a fallback.
Alias for subaccount_id (GHL location id).
⌘I
