Leave an internal note on a conversation. Notes are not messages: they
are never sent to the contact and are only included in the AI's context
when marked AiVisible.
curl --request POST \
--url https://api.closebot.com/lead/{leadId}/note \
--header 'Content-Type: application/json' \
--header 'X-CB-KEY: <api-key>' \
--data '
{
"body": "<string>",
"aiVisible": true,
"mentionedAccountIds": [
"<string>"
]
}
'import requests
url = "https://api.closebot.com/lead/{leadId}/note"
payload = {
"body": "<string>",
"aiVisible": True,
"mentionedAccountIds": ["<string>"]
}
headers = {
"X-CB-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-CB-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
body: JSON.stringify('<string>'),
aiVisible: true,
mentionedAccountIds: ['<string>']
})
};
fetch('https://api.closebot.com/lead/{leadId}/note', 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.closebot.com/lead/{leadId}/note",
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([
'body' => '<string>',
'aiVisible' => true,
'mentionedAccountIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CB-KEY: <api-key>"
],
]);
$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.closebot.com/lead/{leadId}/note"
payload := strings.NewReader("{\n \"body\": \"<string>\",\n \"aiVisible\": true,\n \"mentionedAccountIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-CB-KEY", "<api-key>")
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.closebot.com/lead/{leadId}/note")
.header("X-CB-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"body\": \"<string>\",\n \"aiVisible\": true,\n \"mentionedAccountIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.closebot.com/lead/{leadId}/note")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-CB-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"body\": \"<string>\",\n \"aiVisible\": true,\n \"mentionedAccountIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"noteId": "<string>",
"aiVisible": true
}Lead
Leave an internal note on a conversation. Notes are not messages: they are never sent to the contact and are only included in the AI's context when marked AiVisible.
POST
/
lead
/
{leadId}
/
note
Leave an internal note on a conversation. Notes are not messages: they
are never sent to the contact and are only included in the AI's context
when marked AiVisible.
curl --request POST \
--url https://api.closebot.com/lead/{leadId}/note \
--header 'Content-Type: application/json' \
--header 'X-CB-KEY: <api-key>' \
--data '
{
"body": "<string>",
"aiVisible": true,
"mentionedAccountIds": [
"<string>"
]
}
'import requests
url = "https://api.closebot.com/lead/{leadId}/note"
payload = {
"body": "<string>",
"aiVisible": True,
"mentionedAccountIds": ["<string>"]
}
headers = {
"X-CB-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-CB-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
body: JSON.stringify('<string>'),
aiVisible: true,
mentionedAccountIds: ['<string>']
})
};
fetch('https://api.closebot.com/lead/{leadId}/note', 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.closebot.com/lead/{leadId}/note",
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([
'body' => '<string>',
'aiVisible' => true,
'mentionedAccountIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CB-KEY: <api-key>"
],
]);
$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.closebot.com/lead/{leadId}/note"
payload := strings.NewReader("{\n \"body\": \"<string>\",\n \"aiVisible\": true,\n \"mentionedAccountIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-CB-KEY", "<api-key>")
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.closebot.com/lead/{leadId}/note")
.header("X-CB-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"body\": \"<string>\",\n \"aiVisible\": true,\n \"mentionedAccountIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.closebot.com/lead/{leadId}/note")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-CB-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"body\": \"<string>\",\n \"aiVisible\": true,\n \"mentionedAccountIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"noteId": "<string>",
"aiVisible": true
}Authorizations
CloseBot API Key Authorization
Path Parameters
Body
application/jsontext/jsonapplication/*+json
Whether the AI agent can see this note in its conversation context.
Account IDs of users @-mentioned in the body. Team members are always allowed; clients only if they have access to the lead's source. Anything else is dropped silently.

