Add a source
curl --request POST \
--url https://api.closebot.com/agency/source \
--header 'Content-Type: application/json' \
--header 'X-CB-KEY: <api-key>' \
--data '
{
"name": "<string>",
"category": "<string>",
"key": "<string>",
"accessToken": "<string>",
"refreshToken": "<string>",
"expiresIn": 123,
"autoShutoff": true,
"gracefulGoodbye": true,
"summarizeAttachments": true,
"webhookCallback": "<string>"
}
'import requests
url = "https://api.closebot.com/agency/source"
payload = {
"name": "<string>",
"category": "<string>",
"key": "<string>",
"accessToken": "<string>",
"refreshToken": "<string>",
"expiresIn": 123,
"autoShutoff": True,
"gracefulGoodbye": True,
"summarizeAttachments": True,
"webhookCallback": "<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({
name: '<string>',
category: '<string>',
key: '<string>',
accessToken: '<string>',
refreshToken: '<string>',
expiresIn: 123,
autoShutoff: true,
gracefulGoodbye: true,
summarizeAttachments: true,
webhookCallback: '<string>'
})
};
fetch('https://api.closebot.com/agency/source', 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/agency/source",
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([
'name' => '<string>',
'category' => '<string>',
'key' => '<string>',
'accessToken' => '<string>',
'refreshToken' => '<string>',
'expiresIn' => 123,
'autoShutoff' => true,
'gracefulGoodbye' => true,
'summarizeAttachments' => true,
'webhookCallback' => '<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/agency/source"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"category\": \"<string>\",\n \"key\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"refreshToken\": \"<string>\",\n \"expiresIn\": 123,\n \"autoShutoff\": true,\n \"gracefulGoodbye\": true,\n \"summarizeAttachments\": true,\n \"webhookCallback\": \"<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/agency/source")
.header("X-CB-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"category\": \"<string>\",\n \"key\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"refreshToken\": \"<string>\",\n \"expiresIn\": 123,\n \"autoShutoff\": true,\n \"gracefulGoodbye\": true,\n \"summarizeAttachments\": true,\n \"webhookCallback\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.closebot.com/agency/source")
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 \"name\": \"<string>\",\n \"category\": \"<string>\",\n \"key\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"refreshToken\": \"<string>\",\n \"expiresIn\": 123,\n \"autoShutoff\": true,\n \"gracefulGoodbye\": true,\n \"summarizeAttachments\": true,\n \"webhookCallback\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agencyId": "<string>",
"sourceId": "<string>",
"name": "<string>",
"category": "<string>",
"key": "<string>",
"accessToken": "<string>",
"address": "<string>",
"connected": true,
"autoShutoff": true,
"gracefulGoodbye": true,
"bots": [
{
"id": "<string>",
"botName": "<string>",
"tags": [
{
"name": "<string>",
"approveDeny": true,
"id": "<string>"
}
],
"tagFilterConfig": {
"operator": "<string>",
"groups": [
{
"operator": "<string>",
"rules": [
{
"tagName": "<string>",
"tagId": "<string>",
"condition": "<string>"
}
]
}
]
},
"channels": [
"<string>"
],
"personaNameOverride": "<string>",
"enabled": true
}
],
"accountsWithAccess": [
"<string>"
],
"isAvailabilityContactTimezone": true,
"respondWindows": [
{
"dayOfWeekUtc": "<string>",
"startTimeUtc": "<string>",
"duration": "<string>"
}
],
"doNotRespondWindows": [
{
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
}
],
"botRespondWindows": [
{
"dayOfWeekUtc": "<string>",
"startTimeUtc": "<string>",
"duration": "<string>",
"channel": "<string>"
}
],
"isBotRespondWindowsQuietHours": true,
"summarizeAttachments": true,
"respondToReactions": true,
"markConversationAsUnread": true,
"webhookCallback": "<string>",
"scriptInstalled": true,
"scriptLastSeenAt": "2023-11-07T05:31:56Z",
"scriptLastSeenDomain": "<string>",
"scriptLastSeenEndpoint": "<string>",
"scriptDomainAllowList": [
"<string>"
],
"wallet": {
"reBilling": true,
"autoRefill": true,
"topUpAmount": 123,
"refillThreshold": 123,
"stripeCustomerId": "<string>",
"currency": "<string>",
"responseUnitCostOverride": "<string>",
"storageUnitCostOverride": "<string>",
"userUnitCostOverride": "<string>"
},
"hubSpotOwnerId": "<string>"
}"<string>"Source
Add a source
POST
/
agency
/
source
Add a source
curl --request POST \
--url https://api.closebot.com/agency/source \
--header 'Content-Type: application/json' \
--header 'X-CB-KEY: <api-key>' \
--data '
{
"name": "<string>",
"category": "<string>",
"key": "<string>",
"accessToken": "<string>",
"refreshToken": "<string>",
"expiresIn": 123,
"autoShutoff": true,
"gracefulGoodbye": true,
"summarizeAttachments": true,
"webhookCallback": "<string>"
}
'import requests
url = "https://api.closebot.com/agency/source"
payload = {
"name": "<string>",
"category": "<string>",
"key": "<string>",
"accessToken": "<string>",
"refreshToken": "<string>",
"expiresIn": 123,
"autoShutoff": True,
"gracefulGoodbye": True,
"summarizeAttachments": True,
"webhookCallback": "<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({
name: '<string>',
category: '<string>',
key: '<string>',
accessToken: '<string>',
refreshToken: '<string>',
expiresIn: 123,
autoShutoff: true,
gracefulGoodbye: true,
summarizeAttachments: true,
webhookCallback: '<string>'
})
};
fetch('https://api.closebot.com/agency/source', 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/agency/source",
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([
'name' => '<string>',
'category' => '<string>',
'key' => '<string>',
'accessToken' => '<string>',
'refreshToken' => '<string>',
'expiresIn' => 123,
'autoShutoff' => true,
'gracefulGoodbye' => true,
'summarizeAttachments' => true,
'webhookCallback' => '<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/agency/source"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"category\": \"<string>\",\n \"key\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"refreshToken\": \"<string>\",\n \"expiresIn\": 123,\n \"autoShutoff\": true,\n \"gracefulGoodbye\": true,\n \"summarizeAttachments\": true,\n \"webhookCallback\": \"<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/agency/source")
.header("X-CB-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"category\": \"<string>\",\n \"key\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"refreshToken\": \"<string>\",\n \"expiresIn\": 123,\n \"autoShutoff\": true,\n \"gracefulGoodbye\": true,\n \"summarizeAttachments\": true,\n \"webhookCallback\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.closebot.com/agency/source")
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 \"name\": \"<string>\",\n \"category\": \"<string>\",\n \"key\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"refreshToken\": \"<string>\",\n \"expiresIn\": 123,\n \"autoShutoff\": true,\n \"gracefulGoodbye\": true,\n \"summarizeAttachments\": true,\n \"webhookCallback\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agencyId": "<string>",
"sourceId": "<string>",
"name": "<string>",
"category": "<string>",
"key": "<string>",
"accessToken": "<string>",
"address": "<string>",
"connected": true,
"autoShutoff": true,
"gracefulGoodbye": true,
"bots": [
{
"id": "<string>",
"botName": "<string>",
"tags": [
{
"name": "<string>",
"approveDeny": true,
"id": "<string>"
}
],
"tagFilterConfig": {
"operator": "<string>",
"groups": [
{
"operator": "<string>",
"rules": [
{
"tagName": "<string>",
"tagId": "<string>",
"condition": "<string>"
}
]
}
]
},
"channels": [
"<string>"
],
"personaNameOverride": "<string>",
"enabled": true
}
],
"accountsWithAccess": [
"<string>"
],
"isAvailabilityContactTimezone": true,
"respondWindows": [
{
"dayOfWeekUtc": "<string>",
"startTimeUtc": "<string>",
"duration": "<string>"
}
],
"doNotRespondWindows": [
{
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
}
],
"botRespondWindows": [
{
"dayOfWeekUtc": "<string>",
"startTimeUtc": "<string>",
"duration": "<string>",
"channel": "<string>"
}
],
"isBotRespondWindowsQuietHours": true,
"summarizeAttachments": true,
"respondToReactions": true,
"markConversationAsUnread": true,
"webhookCallback": "<string>",
"scriptInstalled": true,
"scriptLastSeenAt": "2023-11-07T05:31:56Z",
"scriptLastSeenDomain": "<string>",
"scriptLastSeenEndpoint": "<string>",
"scriptDomainAllowList": [
"<string>"
],
"wallet": {
"reBilling": true,
"autoRefill": true,
"topUpAmount": 123,
"refillThreshold": 123,
"stripeCustomerId": "<string>",
"currency": "<string>",
"responseUnitCostOverride": "<string>",
"storageUnitCostOverride": "<string>",
"userUnitCostOverride": "<string>"
},
"hubSpotOwnerId": "<string>"
}"<string>"Authorizations
CloseBot API Key Authorization
Body
application/jsontext/jsonapplication/*+json
Source information.
Response
Success
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I

