Schedule a message to a lead for a future time — either a manually
typed message or one generated at send time by the conversation's
last-responding AI agent.
curl --request POST \
--url https://api.closebot.com/lead/{leadId}/scheduled-message \
--header 'Content-Type: application/json' \
--header 'X-CB-KEY: <api-key>' \
--data '
{
"kind": "<string>",
"sendAt": "2023-11-07T05:31:56Z",
"body": "<string>",
"cancelOnReply": true,
"channel": "<string>"
}
'import requests
url = "https://api.closebot.com/lead/{leadId}/scheduled-message"
payload = {
"kind": "<string>",
"sendAt": "2023-11-07T05:31:56Z",
"body": "<string>",
"cancelOnReply": True,
"channel": "<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({
kind: '<string>',
sendAt: '2023-11-07T05:31:56Z',
body: JSON.stringify('<string>'),
cancelOnReply: true,
channel: '<string>'
})
};
fetch('https://api.closebot.com/lead/{leadId}/scheduled-message', 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}/scheduled-message",
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([
'kind' => '<string>',
'sendAt' => '2023-11-07T05:31:56Z',
'body' => '<string>',
'cancelOnReply' => true,
'channel' => '<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}/scheduled-message"
payload := strings.NewReader("{\n \"kind\": \"<string>\",\n \"sendAt\": \"2023-11-07T05:31:56Z\",\n \"body\": \"<string>\",\n \"cancelOnReply\": true,\n \"channel\": \"<string>\"\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}/scheduled-message")
.header("X-CB-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"kind\": \"<string>\",\n \"sendAt\": \"2023-11-07T05:31:56Z\",\n \"body\": \"<string>\",\n \"cancelOnReply\": true,\n \"channel\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.closebot.com/lead/{leadId}/scheduled-message")
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 \"kind\": \"<string>\",\n \"sendAt\": \"2023-11-07T05:31:56Z\",\n \"body\": \"<string>\",\n \"cancelOnReply\": true,\n \"channel\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"leadId": "<string>",
"kind": "<string>",
"sendAt": "2023-11-07T05:31:56Z",
"cancelOnReply": true,
"status": "<string>",
"createdByAccountId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"sourceId": "<string>",
"body": "<string>",
"channel": "<string>",
"botId": "<string>",
"statusReason": "<string>",
"createdByName": "<string>",
"createdByIconUrl": "<string>",
"sentMessageId": "<string>"
}Lead
Schedule a message to a lead for a future time — either a manually typed message or one generated at send time by the conversation's last-responding AI agent.
POST
/
lead
/
{leadId}
/
scheduled-message
Schedule a message to a lead for a future time — either a manually
typed message or one generated at send time by the conversation's
last-responding AI agent.
curl --request POST \
--url https://api.closebot.com/lead/{leadId}/scheduled-message \
--header 'Content-Type: application/json' \
--header 'X-CB-KEY: <api-key>' \
--data '
{
"kind": "<string>",
"sendAt": "2023-11-07T05:31:56Z",
"body": "<string>",
"cancelOnReply": true,
"channel": "<string>"
}
'import requests
url = "https://api.closebot.com/lead/{leadId}/scheduled-message"
payload = {
"kind": "<string>",
"sendAt": "2023-11-07T05:31:56Z",
"body": "<string>",
"cancelOnReply": True,
"channel": "<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({
kind: '<string>',
sendAt: '2023-11-07T05:31:56Z',
body: JSON.stringify('<string>'),
cancelOnReply: true,
channel: '<string>'
})
};
fetch('https://api.closebot.com/lead/{leadId}/scheduled-message', 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}/scheduled-message",
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([
'kind' => '<string>',
'sendAt' => '2023-11-07T05:31:56Z',
'body' => '<string>',
'cancelOnReply' => true,
'channel' => '<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}/scheduled-message"
payload := strings.NewReader("{\n \"kind\": \"<string>\",\n \"sendAt\": \"2023-11-07T05:31:56Z\",\n \"body\": \"<string>\",\n \"cancelOnReply\": true,\n \"channel\": \"<string>\"\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}/scheduled-message")
.header("X-CB-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"kind\": \"<string>\",\n \"sendAt\": \"2023-11-07T05:31:56Z\",\n \"body\": \"<string>\",\n \"cancelOnReply\": true,\n \"channel\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.closebot.com/lead/{leadId}/scheduled-message")
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 \"kind\": \"<string>\",\n \"sendAt\": \"2023-11-07T05:31:56Z\",\n \"body\": \"<string>\",\n \"cancelOnReply\": true,\n \"channel\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"leadId": "<string>",
"kind": "<string>",
"sendAt": "2023-11-07T05:31:56Z",
"cancelOnReply": true,
"status": "<string>",
"createdByAccountId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"sourceId": "<string>",
"body": "<string>",
"channel": "<string>",
"botId": "<string>",
"statusReason": "<string>",
"createdByName": "<string>",
"createdByIconUrl": "<string>",
"sentMessageId": "<string>"
}Authorizations
CloseBot API Key Authorization
Path Parameters
Body
application/jsontext/jsonapplication/*+json
"manual" sends Body verbatim; "ai" generates the message at send time with the conversation's last-responding agent.
Required for manual messages; ignored for AI messages.
Cancel this message if the contact replies before it sends. Defaults to true for AI messages, false for manual.
Response
OK

