Appointments
Create an appointment
Requires appointments:write.
POST
/
v1
/
appointments
Create an appointment
curl --request POST \
--url https://api.voice.wixzel.com/v1/appointments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_phone": "+14155550100",
"date_time": "2026-09-01T12:00:00.000Z",
"client_name": "<string>",
"duration_minutes": 30,
"notes": "<string>",
"agent_id": "6a96a3ead6e886d42462dd3e",
"lead_id": "6a96a3ead6e886d42462dd3e"
}
'import requests
url = "https://api.voice.wixzel.com/v1/appointments"
payload = {
"client_phone": "+14155550100",
"date_time": "2026-09-01T12:00:00.000Z",
"client_name": "<string>",
"duration_minutes": 30,
"notes": "<string>",
"agent_id": "6a96a3ead6e886d42462dd3e",
"lead_id": "6a96a3ead6e886d42462dd3e"
}
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({
client_phone: '+14155550100',
date_time: '2026-09-01T12:00:00.000Z',
client_name: '<string>',
duration_minutes: 30,
notes: '<string>',
agent_id: '6a96a3ead6e886d42462dd3e',
lead_id: '6a96a3ead6e886d42462dd3e'
})
};
fetch('https://api.voice.wixzel.com/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://api.voice.wixzel.com/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([
'client_phone' => '+14155550100',
'date_time' => '2026-09-01T12:00:00.000Z',
'client_name' => '<string>',
'duration_minutes' => 30,
'notes' => '<string>',
'agent_id' => '6a96a3ead6e886d42462dd3e',
'lead_id' => '6a96a3ead6e886d42462dd3e'
]),
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.voice.wixzel.com/v1/appointments"
payload := strings.NewReader("{\n \"client_phone\": \"+14155550100\",\n \"date_time\": \"2026-09-01T12:00:00.000Z\",\n \"client_name\": \"<string>\",\n \"duration_minutes\": 30,\n \"notes\": \"<string>\",\n \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n \"lead_id\": \"6a96a3ead6e886d42462dd3e\"\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.voice.wixzel.com/v1/appointments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_phone\": \"+14155550100\",\n \"date_time\": \"2026-09-01T12:00:00.000Z\",\n \"client_name\": \"<string>\",\n \"duration_minutes\": 30,\n \"notes\": \"<string>\",\n \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n \"lead_id\": \"6a96a3ead6e886d42462dd3e\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voice.wixzel.com/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 \"client_phone\": \"+14155550100\",\n \"date_time\": \"2026-09-01T12:00:00.000Z\",\n \"client_name\": \"<string>\",\n \"duration_minutes\": 30,\n \"notes\": \"<string>\",\n \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n \"lead_id\": \"6a96a3ead6e886d42462dd3e\"\n}"
response = http.request(request)
puts response.read_body{
"id": "6a96a3ead6e886d42462dd3e",
"object": "appointment",
"client_name": "<string>",
"client_phone": "<string>",
"date_time": "2026-09-01T12:00:00.000Z",
"duration_minutes": 123,
"status": "scheduled",
"notes": "<string>",
"agent_id": "6a96a3ead6e886d42462dd3e",
"lead_id": "6a96a3ead6e886d42462dd3e",
"created_at": "2026-09-01T12:00:00.000Z"
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}Authorizations
Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.
Body
application/json
Pattern:
^\+[1-9]\d{6,14}$Example:
"+14155550100"
ISO 8601, always UTC.
Example:
"2026-09-01T12:00:00.000Z"
Maximum string length:
200Required range:
5 <= x <= 480Maximum string length:
2000Pattern:
^[0-9a-f]{24}$Example:
"6a96a3ead6e886d42462dd3e"
Pattern:
^[0-9a-f]{24}$Example:
"6a96a3ead6e886d42462dd3e"
Response
The created an appointment
Pattern:
^[0-9a-f]{24}$Example:
"6a96a3ead6e886d42462dd3e"
Available options:
appointment ISO 8601, always UTC.
Example:
"2026-09-01T12:00:00.000Z"
Available options:
scheduled, completed, canceled Pattern:
^[0-9a-f]{24}$Example:
"6a96a3ead6e886d42462dd3e"
Pattern:
^[0-9a-f]{24}$Example:
"6a96a3ead6e886d42462dd3e"
ISO 8601, always UTC.
Example:
"2026-09-01T12:00:00.000Z"
⌘I
Create an appointment
curl --request POST \
--url https://api.voice.wixzel.com/v1/appointments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_phone": "+14155550100",
"date_time": "2026-09-01T12:00:00.000Z",
"client_name": "<string>",
"duration_minutes": 30,
"notes": "<string>",
"agent_id": "6a96a3ead6e886d42462dd3e",
"lead_id": "6a96a3ead6e886d42462dd3e"
}
'import requests
url = "https://api.voice.wixzel.com/v1/appointments"
payload = {
"client_phone": "+14155550100",
"date_time": "2026-09-01T12:00:00.000Z",
"client_name": "<string>",
"duration_minutes": 30,
"notes": "<string>",
"agent_id": "6a96a3ead6e886d42462dd3e",
"lead_id": "6a96a3ead6e886d42462dd3e"
}
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({
client_phone: '+14155550100',
date_time: '2026-09-01T12:00:00.000Z',
client_name: '<string>',
duration_minutes: 30,
notes: '<string>',
agent_id: '6a96a3ead6e886d42462dd3e',
lead_id: '6a96a3ead6e886d42462dd3e'
})
};
fetch('https://api.voice.wixzel.com/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://api.voice.wixzel.com/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([
'client_phone' => '+14155550100',
'date_time' => '2026-09-01T12:00:00.000Z',
'client_name' => '<string>',
'duration_minutes' => 30,
'notes' => '<string>',
'agent_id' => '6a96a3ead6e886d42462dd3e',
'lead_id' => '6a96a3ead6e886d42462dd3e'
]),
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.voice.wixzel.com/v1/appointments"
payload := strings.NewReader("{\n \"client_phone\": \"+14155550100\",\n \"date_time\": \"2026-09-01T12:00:00.000Z\",\n \"client_name\": \"<string>\",\n \"duration_minutes\": 30,\n \"notes\": \"<string>\",\n \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n \"lead_id\": \"6a96a3ead6e886d42462dd3e\"\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.voice.wixzel.com/v1/appointments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_phone\": \"+14155550100\",\n \"date_time\": \"2026-09-01T12:00:00.000Z\",\n \"client_name\": \"<string>\",\n \"duration_minutes\": 30,\n \"notes\": \"<string>\",\n \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n \"lead_id\": \"6a96a3ead6e886d42462dd3e\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voice.wixzel.com/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 \"client_phone\": \"+14155550100\",\n \"date_time\": \"2026-09-01T12:00:00.000Z\",\n \"client_name\": \"<string>\",\n \"duration_minutes\": 30,\n \"notes\": \"<string>\",\n \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n \"lead_id\": \"6a96a3ead6e886d42462dd3e\"\n}"
response = http.request(request)
puts response.read_body{
"id": "6a96a3ead6e886d42462dd3e",
"object": "appointment",
"client_name": "<string>",
"client_phone": "<string>",
"date_time": "2026-09-01T12:00:00.000Z",
"duration_minutes": 123,
"status": "scheduled",
"notes": "<string>",
"agent_id": "6a96a3ead6e886d42462dd3e",
"lead_id": "6a96a3ead6e886d42462dd3e",
"created_at": "2026-09-01T12:00:00.000Z"
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}
