Send a supervisor note to an agent
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/agents/conversations/{conversationId}/supervisor-notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"note": "The customer is on the Pro plan — offer the priority-support callback."
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/conversations/{conversationId}/supervisor-notes"
payload = { "note": "The customer is on the Pro plan — offer the priority-support callback." }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({note: 'The customer is on the Pro plan — offer the priority-support callback.'})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/conversations/{conversationId}/supervisor-notes', 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.orbit.devotel.io/api/v1/agents/conversations/{conversationId}/supervisor-notes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'note' => 'The customer is on the Pro plan — offer the priority-support callback.'
]),
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.orbit.devotel.io/api/v1/agents/conversations/{conversationId}/supervisor-notes"
payload := strings.NewReader("{\n \"note\": \"The customer is on the Pro plan — offer the priority-support callback.\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.orbit.devotel.io/api/v1/agents/conversations/{conversationId}/supervisor-notes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"note\": \"The customer is on the Pro plan — offer the priority-support callback.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/conversations/{conversationId}/supervisor-notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"note\": \"The customer is on the Pro plan — offer the priority-support callback.\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "note_3fa1c8",
"conversation_id": "conv_8b21d0"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Agents
Send a supervisor note to an agent
Send a one-way supervisor “whisper” note to an agent during a live conversation; the agent reads it on its next turn to steer the reply without the customer seeing it. Use it to coach an agent mid-conversation — correct a fact, nudge the tone, or add context. The note must be 1–1000 characters and the conversation must still be active. Requires an owner, admin, or supervisor role.
POST
/
api
/
v1
/
agents
/
conversations
/
{conversationId}
/
supervisor-notes
Send a supervisor note to an agent
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/agents/conversations/{conversationId}/supervisor-notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"note": "The customer is on the Pro plan — offer the priority-support callback."
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/conversations/{conversationId}/supervisor-notes"
payload = { "note": "The customer is on the Pro plan — offer the priority-support callback." }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({note: 'The customer is on the Pro plan — offer the priority-support callback.'})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/conversations/{conversationId}/supervisor-notes', 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.orbit.devotel.io/api/v1/agents/conversations/{conversationId}/supervisor-notes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'note' => 'The customer is on the Pro plan — offer the priority-support callback.'
]),
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.orbit.devotel.io/api/v1/agents/conversations/{conversationId}/supervisor-notes"
payload := strings.NewReader("{\n \"note\": \"The customer is on the Pro plan — offer the priority-support callback.\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.orbit.devotel.io/api/v1/agents/conversations/{conversationId}/supervisor-notes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"note\": \"The customer is on the Pro plan — offer the priority-support callback.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/conversations/{conversationId}/supervisor-notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"note\": \"The customer is on the Pro plan — offer the priority-support callback.\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "note_3fa1c8",
"conversation_id": "conv_8b21d0"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
Agent conversation identifier.
Body
application/json
The guidance the agent should apply on its next turn.
Required string length:
1 - 1000⌘I