Conversations
Update conversation policy
Requires conversations:policy:write. At least one operation is required. freezeForMinutes conflicts with unfreeze=true. Unresolved handoffs lock policy changes.
PATCH
/
conversations
/
{conversationId}
/
policy
Update conversation policy
curl --request PATCH \
--url https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"manualEnabled": true,
"freezeForMinutes": 60.5,
"unfreeze": true
}
'import requests
url = "https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/policy"
payload = {
"manualEnabled": True,
"freezeForMinutes": 60.5,
"unfreeze": True
}
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({manualEnabled: true, freezeForMinutes: 60.5, unfreeze: true})
};
fetch('https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/policy', 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://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/policy",
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([
'manualEnabled' => true,
'freezeForMinutes' => 60.5,
'unfreeze' => true
]),
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://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/policy"
payload := strings.NewReader("{\n \"manualEnabled\": true,\n \"freezeForMinutes\": 60.5,\n \"unfreeze\": true\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://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/policy")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"manualEnabled\": true,\n \"freezeForMinutes\": 60.5,\n \"unfreeze\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/policy")
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 \"manualEnabled\": true,\n \"freezeForMinutes\": 60.5,\n \"unfreeze\": true\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"conversationId": "<string>",
"changed": true,
"statusBefore": "<string>",
"statusAfter": "<string>",
"manualEnabledBefore": true,
"manualEnabledAfter": true,
"frozenUntilAtAfter": "2023-11-07T05:31:56Z",
"conversationKey": "<string>",
"frozenUntilAtBefore": "<string>",
"isFrozenBefore": true,
"isFrozenAfter": true,
"frozenSecondsRemainingAfter": 123
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}Authorizations
Server-side tenant-scoped credential created from Build > API Keys.
Path Parameters
Body
application/json
Response
Success
⌘I
Update conversation policy
curl --request PATCH \
--url https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"manualEnabled": true,
"freezeForMinutes": 60.5,
"unfreeze": true
}
'import requests
url = "https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/policy"
payload = {
"manualEnabled": True,
"freezeForMinutes": 60.5,
"unfreeze": True
}
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({manualEnabled: true, freezeForMinutes: 60.5, unfreeze: true})
};
fetch('https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/policy', 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://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/policy",
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([
'manualEnabled' => true,
'freezeForMinutes' => 60.5,
'unfreeze' => true
]),
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://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/policy"
payload := strings.NewReader("{\n \"manualEnabled\": true,\n \"freezeForMinutes\": 60.5,\n \"unfreeze\": true\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://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/policy")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"manualEnabled\": true,\n \"freezeForMinutes\": 60.5,\n \"unfreeze\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/policy")
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 \"manualEnabled\": true,\n \"freezeForMinutes\": 60.5,\n \"unfreeze\": true\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"conversationId": "<string>",
"changed": true,
"statusBefore": "<string>",
"statusAfter": "<string>",
"manualEnabledBefore": true,
"manualEnabledAfter": true,
"frozenUntilAtAfter": "2023-11-07T05:31:56Z",
"conversationKey": "<string>",
"frozenUntilAtBefore": "<string>",
"isFrozenBefore": true,
"isFrozenAfter": true,
"frozenSecondsRemainingAfter": 123
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}