Appointments
Book appointment
Books a slot on a calendar for a contact. Runs the same availability, capacity, and daily-limit checks as the booking webview, and schedules reminders/confirmation flow if configured on the calendar.
POST
/
v1
/
appointments
Book appointment
curl --request POST \
--url https://app.chatbotx.io/api/v1/appointments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"calendarId": "<string>",
"contactId": "<string>",
"startAt": "2023-11-07T05:31:56Z",
"conversationId": "<string>",
"inviteeTimezone": "<string>"
}
'import requests
url = "https://app.chatbotx.io/api/v1/appointments"
payload = {
"calendarId": "<string>",
"contactId": "<string>",
"startAt": "2023-11-07T05:31:56Z",
"conversationId": "<string>",
"inviteeTimezone": "<string>"
}
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({
calendarId: '<string>',
contactId: '<string>',
startAt: '2023-11-07T05:31:56Z',
conversationId: '<string>',
inviteeTimezone: '<string>'
})
};
fetch('https://app.chatbotx.io/api/v1/appointments', 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://app.chatbotx.io/api/v1/appointments",
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([
'calendarId' => '<string>',
'contactId' => '<string>',
'startAt' => '2023-11-07T05:31:56Z',
'conversationId' => '<string>',
'inviteeTimezone' => '<string>'
]),
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://app.chatbotx.io/api/v1/appointments"
payload := strings.NewReader("{\n \"calendarId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"conversationId\": \"<string>\",\n \"inviteeTimezone\": \"<string>\"\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://app.chatbotx.io/api/v1/appointments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"calendarId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"conversationId\": \"<string>\",\n \"inviteeTimezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chatbotx.io/api/v1/appointments")
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 \"calendarId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"conversationId\": \"<string>\",\n \"inviteeTimezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"calendarId": "<string>",
"contactId": "<string>",
"conversationId": "<string>",
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z",
"inviteeTimezone": "<string>",
"status": "scheduled",
"locationType": "inPerson",
"locationDetail": "<string>",
"externalEventId": "<string>",
"cancelledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"defined": true,
"code": "businessError",
"status": 400,
"message": "An error occurred while processing your request",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": "<unknown>"
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "You do not have permission to perform this action",
"data": "<unknown>"
}{
"defined": true,
"code": "notFound",
"status": 404,
"message": "Resource not found",
"data": "<unknown>"
}{
"defined": true,
"code": "slotUnavailable",
"status": 409,
"message": "Appointment slot is unavailable",
"data": "<unknown>"
}{
"defined": true,
"code": "invalidRequestData",
"status": 422,
"message": "Input validation failed",
"data": {
"issues": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
}{
"defined": true,
"code": "tooManyRequests",
"status": 429,
"message": "Too many requests",
"data": "<unknown>"
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An unexpected error occurred",
"data": "<unknown>"
}Authorizations
bearerAuthdeveloperAccessTokentokenInSearchParams
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Calendar to book on. Get it from appointmentCalendars.list.
Pattern:
^\d+$Contact id. Get it from contacts.list.
Pattern:
^\d+$Slot start time.
Conversation to associate the booking with, if any.
Pattern:
^\d+$IANA timezone of the invitee, for display purposes.
Response
OK
Available options:
scheduled, cancelled Available options:
inPerson, phoneCall, onlineMeeting Was this page helpful?
⌘I
Book appointment
curl --request POST \
--url https://app.chatbotx.io/api/v1/appointments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"calendarId": "<string>",
"contactId": "<string>",
"startAt": "2023-11-07T05:31:56Z",
"conversationId": "<string>",
"inviteeTimezone": "<string>"
}
'import requests
url = "https://app.chatbotx.io/api/v1/appointments"
payload = {
"calendarId": "<string>",
"contactId": "<string>",
"startAt": "2023-11-07T05:31:56Z",
"conversationId": "<string>",
"inviteeTimezone": "<string>"
}
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({
calendarId: '<string>',
contactId: '<string>',
startAt: '2023-11-07T05:31:56Z',
conversationId: '<string>',
inviteeTimezone: '<string>'
})
};
fetch('https://app.chatbotx.io/api/v1/appointments', 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://app.chatbotx.io/api/v1/appointments",
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([
'calendarId' => '<string>',
'contactId' => '<string>',
'startAt' => '2023-11-07T05:31:56Z',
'conversationId' => '<string>',
'inviteeTimezone' => '<string>'
]),
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://app.chatbotx.io/api/v1/appointments"
payload := strings.NewReader("{\n \"calendarId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"conversationId\": \"<string>\",\n \"inviteeTimezone\": \"<string>\"\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://app.chatbotx.io/api/v1/appointments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"calendarId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"conversationId\": \"<string>\",\n \"inviteeTimezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chatbotx.io/api/v1/appointments")
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 \"calendarId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"conversationId\": \"<string>\",\n \"inviteeTimezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"calendarId": "<string>",
"contactId": "<string>",
"conversationId": "<string>",
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z",
"inviteeTimezone": "<string>",
"status": "scheduled",
"locationType": "inPerson",
"locationDetail": "<string>",
"externalEventId": "<string>",
"cancelledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"defined": true,
"code": "businessError",
"status": 400,
"message": "An error occurred while processing your request",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": "<unknown>"
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "You do not have permission to perform this action",
"data": "<unknown>"
}{
"defined": true,
"code": "notFound",
"status": 404,
"message": "Resource not found",
"data": "<unknown>"
}{
"defined": true,
"code": "slotUnavailable",
"status": 409,
"message": "Appointment slot is unavailable",
"data": "<unknown>"
}{
"defined": true,
"code": "invalidRequestData",
"status": 422,
"message": "Input validation failed",
"data": {
"issues": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
}{
"defined": true,
"code": "tooManyRequests",
"status": 429,
"message": "Too many requests",
"data": "<unknown>"
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An unexpected error occurred",
"data": "<unknown>"
}