curl --request PUT \
--url https://app.flextell.ai/api/v1/appointments/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Tenant: <x-tenant>' \
--data '
{
"customer_id": 123,
"user_id": 123,
"is_control_appointment": true,
"assistant_id": 123,
"assistant_ids": [
123
],
"parent_appointment_id": "<string>",
"description": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"send_message": true,
"channel_id": 123,
"channel_identifier": "<string>",
"duration_minutes": 722,
"cancellation_reason": "<string>",
"room_id": 123,
"tags": [
123
],
"treatments": [
123
],
"treatment_session_plans": [
{
"treatment_id": 123,
"sessions": [
{
"session_order": 1,
"offset_days": 1,
"next_gap_days": 2,
"is_custom": true,
"scheduled_at": "2023-11-07T05:31:56Z",
"products": [
{
"product_id": 123,
"warehouse_id": 123,
"quantity": 1.001
}
]
}
]
}
]
}
'import requests
url = "https://app.flextell.ai/api/v1/appointments/{id}"
payload = {
"customer_id": 123,
"user_id": 123,
"is_control_appointment": True,
"assistant_id": 123,
"assistant_ids": [123],
"parent_appointment_id": "<string>",
"description": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"send_message": True,
"channel_id": 123,
"channel_identifier": "<string>",
"duration_minutes": 722,
"cancellation_reason": "<string>",
"room_id": 123,
"tags": [123],
"treatments": [123],
"treatment_session_plans": [
{
"treatment_id": 123,
"sessions": [
{
"session_order": 1,
"offset_days": 1,
"next_gap_days": 2,
"is_custom": True,
"scheduled_at": "2023-11-07T05:31:56Z",
"products": [
{
"product_id": 123,
"warehouse_id": 123,
"quantity": 1.001
}
]
}
]
}
]
}
headers = {
"X-Tenant": "<x-tenant>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Tenant': '<x-tenant>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
customer_id: 123,
user_id: 123,
is_control_appointment: true,
assistant_id: 123,
assistant_ids: [123],
parent_appointment_id: '<string>',
description: '<string>',
scheduled_at: '2023-11-07T05:31:56Z',
send_message: true,
channel_id: 123,
channel_identifier: '<string>',
duration_minutes: 722,
cancellation_reason: '<string>',
room_id: 123,
tags: [123],
treatments: [123],
treatment_session_plans: [
{
treatment_id: 123,
sessions: [
{
session_order: 1,
offset_days: 1,
next_gap_days: 2,
is_custom: true,
scheduled_at: '2023-11-07T05:31:56Z',
products: [{product_id: 123, warehouse_id: 123, quantity: 1.001}]
}
]
}
]
})
};
fetch('https://app.flextell.ai/api/v1/appointments/{id}', 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.flextell.ai/api/v1/appointments/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'customer_id' => 123,
'user_id' => 123,
'is_control_appointment' => true,
'assistant_id' => 123,
'assistant_ids' => [
123
],
'parent_appointment_id' => '<string>',
'description' => '<string>',
'scheduled_at' => '2023-11-07T05:31:56Z',
'send_message' => true,
'channel_id' => 123,
'channel_identifier' => '<string>',
'duration_minutes' => 722,
'cancellation_reason' => '<string>',
'room_id' => 123,
'tags' => [
123
],
'treatments' => [
123
],
'treatment_session_plans' => [
[
'treatment_id' => 123,
'sessions' => [
[
'session_order' => 1,
'offset_days' => 1,
'next_gap_days' => 2,
'is_custom' => true,
'scheduled_at' => '2023-11-07T05:31:56Z',
'products' => [
[
'product_id' => 123,
'warehouse_id' => 123,
'quantity' => 1.001
]
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Tenant: <x-tenant>"
],
]);
$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.flextell.ai/api/v1/appointments/{id}"
payload := strings.NewReader("{\n \"customer_id\": 123,\n \"user_id\": 123,\n \"is_control_appointment\": true,\n \"assistant_id\": 123,\n \"assistant_ids\": [\n 123\n ],\n \"parent_appointment_id\": \"<string>\",\n \"description\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"send_message\": true,\n \"channel_id\": 123,\n \"channel_identifier\": \"<string>\",\n \"duration_minutes\": 722,\n \"cancellation_reason\": \"<string>\",\n \"room_id\": 123,\n \"tags\": [\n 123\n ],\n \"treatments\": [\n 123\n ],\n \"treatment_session_plans\": [\n {\n \"treatment_id\": 123,\n \"sessions\": [\n {\n \"session_order\": 1,\n \"offset_days\": 1,\n \"next_gap_days\": 2,\n \"is_custom\": true,\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"products\": [\n {\n \"product_id\": 123,\n \"warehouse_id\": 123,\n \"quantity\": 1.001\n }\n ]\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Tenant", "<x-tenant>")
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.put("https://app.flextell.ai/api/v1/appointments/{id}")
.header("X-Tenant", "<x-tenant>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": 123,\n \"user_id\": 123,\n \"is_control_appointment\": true,\n \"assistant_id\": 123,\n \"assistant_ids\": [\n 123\n ],\n \"parent_appointment_id\": \"<string>\",\n \"description\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"send_message\": true,\n \"channel_id\": 123,\n \"channel_identifier\": \"<string>\",\n \"duration_minutes\": 722,\n \"cancellation_reason\": \"<string>\",\n \"room_id\": 123,\n \"tags\": [\n 123\n ],\n \"treatments\": [\n 123\n ],\n \"treatment_session_plans\": [\n {\n \"treatment_id\": 123,\n \"sessions\": [\n {\n \"session_order\": 1,\n \"offset_days\": 1,\n \"next_gap_days\": 2,\n \"is_custom\": true,\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"products\": [\n {\n \"product_id\": 123,\n \"warehouse_id\": 123,\n \"quantity\": 1.001\n }\n ]\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.flextell.ai/api/v1/appointments/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Tenant"] = '<x-tenant>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": 123,\n \"user_id\": 123,\n \"is_control_appointment\": true,\n \"assistant_id\": 123,\n \"assistant_ids\": [\n 123\n ],\n \"parent_appointment_id\": \"<string>\",\n \"description\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"send_message\": true,\n \"channel_id\": 123,\n \"channel_identifier\": \"<string>\",\n \"duration_minutes\": 722,\n \"cancellation_reason\": \"<string>\",\n \"room_id\": 123,\n \"tags\": [\n 123\n ],\n \"treatments\": [\n 123\n ],\n \"treatment_session_plans\": [\n {\n \"treatment_id\": 123,\n \"sessions\": [\n {\n \"session_order\": 1,\n \"offset_days\": 1,\n \"next_gap_days\": 2,\n \"is_custom\": true,\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"products\": [\n {\n \"product_id\": 123,\n \"warehouse_id\": 123,\n \"quantity\": 1.001\n }\n ]\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": "<string>",
"data": {
"id": 123,
"record_state": {
"is_read_only": true,
"reason_code": "<string>"
},
"customer_id": 123,
"room_id": 123,
"channel_id": 123,
"parent_appointment_id": 123,
"code": "<string>",
"relation_type": "<string>",
"description": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"duration_minutes": 123,
"status": "<string>",
"cancellation_reason": "<string>",
"creation_type": "<string>",
"is_control_appointment": true,
"is_ai_generated": true,
"import_source_id": 123,
"pending_scheduled_at": "2023-11-07T05:31:56Z",
"pending_expires_at": "2023-11-07T05:31:56Z",
"assistants": [
{
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"sale_id": 123,
"has_sale": true,
"customer": {
"id": 123,
"record_state": {
"is_read_only": true,
"reason_code": "<string>"
},
"first_name": "<string>",
"last_name": "<string>",
"phone_number": "<string>",
"email": "<string>",
"date_of_birth": "<string>",
"gender": "male",
"country_id": 123,
"country_name": "<string>",
"city_id": 123,
"city_name": "<string>",
"district_id": 123,
"district_name": "<string>",
"identity_number": "<string>",
"passport_number": "<string>",
"occupation_id": 123,
"occupation_name": "<string>",
"address": "<string>",
"default_channel_id": 123,
"default_channel_name": "<string>",
"latest_conversation_id": 123,
"avatar_url": "<string>",
"is_lead_stage": true,
"lead_id": 123,
"is_masked": true,
"related_user": {
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"erased_at": "2023-11-07T05:31:56Z",
"tags": [
{
"id": 123,
"tenant_id": 123,
"name": "<string>",
"color": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"notification_channels": {
"default_channel_id": "<string>",
"source": "<string>",
"channels": [
"<unknown>"
]
},
"import_source": {
"id": 123,
"name": "<string>",
"company_logo": null
}
},
"doctor": {
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
},
"room": {
"id": 123,
"name": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"parent_appointment": "<unknown>",
"child_appointments": "<array>",
"treatments": [
{
"id": 123,
"group_id": 123,
"name": "<string>",
"invoice_name": "<string>",
"keywords": [
"<unknown>"
],
"price": "<string>",
"tax_rate": 123,
"description": "<string>",
"session": 123,
"is_active": "<string>",
"extra_info": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"group": {
"id": 123,
"name": "<string>",
"is_active": true
},
"users": [
{
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
}
],
"sessions": [
{
"id": 123,
"session_order": 123,
"session_type": "control",
"next_gap_days": 123,
"offset_days": 123,
"products": [
{
"id": 123,
"product_id": 123,
"min_quantity": 123,
"product": {
"id": 123,
"name": "<string>",
"full_name": "<string>",
"brand": {
"id": 123,
"name": "<string>"
},
"unit_code": {
"id": "<string>",
"name": "<string>",
"code": "<string>"
}
}
}
]
}
],
"import_source": {
"id": 123,
"name": "<string>",
"company_logo": null
}
}
],
"treatment_session_plans": [
{
"treatment_id": 123,
"sessions": [
{
"id": 123,
"record_state": {
"is_read_only": true,
"reason_code": "<string>"
},
"appointment_id": 123,
"session_order": 123,
"is_custom": true,
"session_type": "<string>",
"offset_days": 123,
"next_gap_days": 123,
"scheduled_at": "2023-11-07T05:31:56Z",
"products": [
{
"id": 123,
"quantity": 123,
"name": "<string>",
"full_name": "<string>",
"unit_code": {
"id": "<string>",
"name": "<string>",
"code": "<string>"
}
}
]
}
]
}
],
"linked_sessions": [
{
"id": 123,
"session_order": 123,
"session_type": "<string>",
"treatment": {
"id": 123,
"name": "<string>",
"display_name": "<string>"
},
"products": [
{
"id": 123,
"quantity": 123,
"name": "<string>",
"full_name": "<string>",
"unit_code": {
"id": "<string>",
"name": "<string>",
"code": "<string>"
}
}
]
}
],
"tags": [
{
"id": 123,
"tenant_id": 123,
"name": "<string>",
"color": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"reminders": [
{
"id": 123,
"record_state": {
"is_read_only": true,
"reason_code": "<string>"
},
"appointment_id": 123,
"tenant_id": 123,
"type": "<string>",
"offset_days": 123,
"scheduled_for": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"channel": "<string>",
"message": "<string>",
"status": "<string>",
"approval_status": "<string>",
"approved_at": "2023-11-07T05:31:56Z",
"approved_by": 123,
"metadata": [
"<unknown>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"appointment": {
"id": 123,
"record_state": {
"is_read_only": true,
"reason_code": "<string>"
},
"code": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"relation_type": "<string>",
"parent_appointment_id": 123,
"customer": {
"id": 123,
"record_state": {
"is_read_only": true,
"reason_code": "<string>"
},
"first_name": "<string>",
"last_name": "<string>",
"phone_number": "<string>",
"email": "<string>",
"is_masked": true,
"is_lead_stage": true,
"lead_id": 123
},
"doctor": {
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
},
"treatments": [
{
"id": 123,
"name": "<string>",
"group": {
"id": 123,
"name": "<string>"
}
}
],
"parent_appointment": null
},
"approver": {
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
}
}
],
"customer_balance": {
"outstanding_balance": "<string>",
"overdue_balance": "<string>",
"currency_code": "<string>"
},
"import_source": {
"id": 123,
"name": "<string>",
"company_logo": null
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"success": true,
"error_code": "RESOURCE_NOT_FOUND",
"message": "<string>",
"errors": null,
"data": null
}{
"success": false,
"error_code": "CUSTOMER_ERASED",
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"success": false,
"error_code": "SETUP_REQUIRED",
"message": "Complete the required setup steps to continue.",
"data": {
"next_step": "clinic_info"
}
}Update an appointment
Moving scheduled_at to a different minute while a reschedule proposal is waiting for the
patient cancels that proposal: pending_scheduled_at/pending_expires_at are cleared and the
confirmation message is marked superseded; if it was the batch’s last open proposal, the batch summary goes out.
Sending the unchanged scheduled_at keeps it.
curl --request PUT \
--url https://app.flextell.ai/api/v1/appointments/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Tenant: <x-tenant>' \
--data '
{
"customer_id": 123,
"user_id": 123,
"is_control_appointment": true,
"assistant_id": 123,
"assistant_ids": [
123
],
"parent_appointment_id": "<string>",
"description": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"send_message": true,
"channel_id": 123,
"channel_identifier": "<string>",
"duration_minutes": 722,
"cancellation_reason": "<string>",
"room_id": 123,
"tags": [
123
],
"treatments": [
123
],
"treatment_session_plans": [
{
"treatment_id": 123,
"sessions": [
{
"session_order": 1,
"offset_days": 1,
"next_gap_days": 2,
"is_custom": true,
"scheduled_at": "2023-11-07T05:31:56Z",
"products": [
{
"product_id": 123,
"warehouse_id": 123,
"quantity": 1.001
}
]
}
]
}
]
}
'import requests
url = "https://app.flextell.ai/api/v1/appointments/{id}"
payload = {
"customer_id": 123,
"user_id": 123,
"is_control_appointment": True,
"assistant_id": 123,
"assistant_ids": [123],
"parent_appointment_id": "<string>",
"description": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"send_message": True,
"channel_id": 123,
"channel_identifier": "<string>",
"duration_minutes": 722,
"cancellation_reason": "<string>",
"room_id": 123,
"tags": [123],
"treatments": [123],
"treatment_session_plans": [
{
"treatment_id": 123,
"sessions": [
{
"session_order": 1,
"offset_days": 1,
"next_gap_days": 2,
"is_custom": True,
"scheduled_at": "2023-11-07T05:31:56Z",
"products": [
{
"product_id": 123,
"warehouse_id": 123,
"quantity": 1.001
}
]
}
]
}
]
}
headers = {
"X-Tenant": "<x-tenant>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Tenant': '<x-tenant>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
customer_id: 123,
user_id: 123,
is_control_appointment: true,
assistant_id: 123,
assistant_ids: [123],
parent_appointment_id: '<string>',
description: '<string>',
scheduled_at: '2023-11-07T05:31:56Z',
send_message: true,
channel_id: 123,
channel_identifier: '<string>',
duration_minutes: 722,
cancellation_reason: '<string>',
room_id: 123,
tags: [123],
treatments: [123],
treatment_session_plans: [
{
treatment_id: 123,
sessions: [
{
session_order: 1,
offset_days: 1,
next_gap_days: 2,
is_custom: true,
scheduled_at: '2023-11-07T05:31:56Z',
products: [{product_id: 123, warehouse_id: 123, quantity: 1.001}]
}
]
}
]
})
};
fetch('https://app.flextell.ai/api/v1/appointments/{id}', 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.flextell.ai/api/v1/appointments/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'customer_id' => 123,
'user_id' => 123,
'is_control_appointment' => true,
'assistant_id' => 123,
'assistant_ids' => [
123
],
'parent_appointment_id' => '<string>',
'description' => '<string>',
'scheduled_at' => '2023-11-07T05:31:56Z',
'send_message' => true,
'channel_id' => 123,
'channel_identifier' => '<string>',
'duration_minutes' => 722,
'cancellation_reason' => '<string>',
'room_id' => 123,
'tags' => [
123
],
'treatments' => [
123
],
'treatment_session_plans' => [
[
'treatment_id' => 123,
'sessions' => [
[
'session_order' => 1,
'offset_days' => 1,
'next_gap_days' => 2,
'is_custom' => true,
'scheduled_at' => '2023-11-07T05:31:56Z',
'products' => [
[
'product_id' => 123,
'warehouse_id' => 123,
'quantity' => 1.001
]
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Tenant: <x-tenant>"
],
]);
$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.flextell.ai/api/v1/appointments/{id}"
payload := strings.NewReader("{\n \"customer_id\": 123,\n \"user_id\": 123,\n \"is_control_appointment\": true,\n \"assistant_id\": 123,\n \"assistant_ids\": [\n 123\n ],\n \"parent_appointment_id\": \"<string>\",\n \"description\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"send_message\": true,\n \"channel_id\": 123,\n \"channel_identifier\": \"<string>\",\n \"duration_minutes\": 722,\n \"cancellation_reason\": \"<string>\",\n \"room_id\": 123,\n \"tags\": [\n 123\n ],\n \"treatments\": [\n 123\n ],\n \"treatment_session_plans\": [\n {\n \"treatment_id\": 123,\n \"sessions\": [\n {\n \"session_order\": 1,\n \"offset_days\": 1,\n \"next_gap_days\": 2,\n \"is_custom\": true,\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"products\": [\n {\n \"product_id\": 123,\n \"warehouse_id\": 123,\n \"quantity\": 1.001\n }\n ]\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Tenant", "<x-tenant>")
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.put("https://app.flextell.ai/api/v1/appointments/{id}")
.header("X-Tenant", "<x-tenant>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": 123,\n \"user_id\": 123,\n \"is_control_appointment\": true,\n \"assistant_id\": 123,\n \"assistant_ids\": [\n 123\n ],\n \"parent_appointment_id\": \"<string>\",\n \"description\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"send_message\": true,\n \"channel_id\": 123,\n \"channel_identifier\": \"<string>\",\n \"duration_minutes\": 722,\n \"cancellation_reason\": \"<string>\",\n \"room_id\": 123,\n \"tags\": [\n 123\n ],\n \"treatments\": [\n 123\n ],\n \"treatment_session_plans\": [\n {\n \"treatment_id\": 123,\n \"sessions\": [\n {\n \"session_order\": 1,\n \"offset_days\": 1,\n \"next_gap_days\": 2,\n \"is_custom\": true,\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"products\": [\n {\n \"product_id\": 123,\n \"warehouse_id\": 123,\n \"quantity\": 1.001\n }\n ]\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.flextell.ai/api/v1/appointments/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Tenant"] = '<x-tenant>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": 123,\n \"user_id\": 123,\n \"is_control_appointment\": true,\n \"assistant_id\": 123,\n \"assistant_ids\": [\n 123\n ],\n \"parent_appointment_id\": \"<string>\",\n \"description\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"send_message\": true,\n \"channel_id\": 123,\n \"channel_identifier\": \"<string>\",\n \"duration_minutes\": 722,\n \"cancellation_reason\": \"<string>\",\n \"room_id\": 123,\n \"tags\": [\n 123\n ],\n \"treatments\": [\n 123\n ],\n \"treatment_session_plans\": [\n {\n \"treatment_id\": 123,\n \"sessions\": [\n {\n \"session_order\": 1,\n \"offset_days\": 1,\n \"next_gap_days\": 2,\n \"is_custom\": true,\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"products\": [\n {\n \"product_id\": 123,\n \"warehouse_id\": 123,\n \"quantity\": 1.001\n }\n ]\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": "<string>",
"data": {
"id": 123,
"record_state": {
"is_read_only": true,
"reason_code": "<string>"
},
"customer_id": 123,
"room_id": 123,
"channel_id": 123,
"parent_appointment_id": 123,
"code": "<string>",
"relation_type": "<string>",
"description": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"duration_minutes": 123,
"status": "<string>",
"cancellation_reason": "<string>",
"creation_type": "<string>",
"is_control_appointment": true,
"is_ai_generated": true,
"import_source_id": 123,
"pending_scheduled_at": "2023-11-07T05:31:56Z",
"pending_expires_at": "2023-11-07T05:31:56Z",
"assistants": [
{
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"sale_id": 123,
"has_sale": true,
"customer": {
"id": 123,
"record_state": {
"is_read_only": true,
"reason_code": "<string>"
},
"first_name": "<string>",
"last_name": "<string>",
"phone_number": "<string>",
"email": "<string>",
"date_of_birth": "<string>",
"gender": "male",
"country_id": 123,
"country_name": "<string>",
"city_id": 123,
"city_name": "<string>",
"district_id": 123,
"district_name": "<string>",
"identity_number": "<string>",
"passport_number": "<string>",
"occupation_id": 123,
"occupation_name": "<string>",
"address": "<string>",
"default_channel_id": 123,
"default_channel_name": "<string>",
"latest_conversation_id": 123,
"avatar_url": "<string>",
"is_lead_stage": true,
"lead_id": 123,
"is_masked": true,
"related_user": {
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"erased_at": "2023-11-07T05:31:56Z",
"tags": [
{
"id": 123,
"tenant_id": 123,
"name": "<string>",
"color": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"notification_channels": {
"default_channel_id": "<string>",
"source": "<string>",
"channels": [
"<unknown>"
]
},
"import_source": {
"id": 123,
"name": "<string>",
"company_logo": null
}
},
"doctor": {
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
},
"room": {
"id": 123,
"name": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"parent_appointment": "<unknown>",
"child_appointments": "<array>",
"treatments": [
{
"id": 123,
"group_id": 123,
"name": "<string>",
"invoice_name": "<string>",
"keywords": [
"<unknown>"
],
"price": "<string>",
"tax_rate": 123,
"description": "<string>",
"session": 123,
"is_active": "<string>",
"extra_info": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"group": {
"id": 123,
"name": "<string>",
"is_active": true
},
"users": [
{
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
}
],
"sessions": [
{
"id": 123,
"session_order": 123,
"session_type": "control",
"next_gap_days": 123,
"offset_days": 123,
"products": [
{
"id": 123,
"product_id": 123,
"min_quantity": 123,
"product": {
"id": 123,
"name": "<string>",
"full_name": "<string>",
"brand": {
"id": 123,
"name": "<string>"
},
"unit_code": {
"id": "<string>",
"name": "<string>",
"code": "<string>"
}
}
}
]
}
],
"import_source": {
"id": 123,
"name": "<string>",
"company_logo": null
}
}
],
"treatment_session_plans": [
{
"treatment_id": 123,
"sessions": [
{
"id": 123,
"record_state": {
"is_read_only": true,
"reason_code": "<string>"
},
"appointment_id": 123,
"session_order": 123,
"is_custom": true,
"session_type": "<string>",
"offset_days": 123,
"next_gap_days": 123,
"scheduled_at": "2023-11-07T05:31:56Z",
"products": [
{
"id": 123,
"quantity": 123,
"name": "<string>",
"full_name": "<string>",
"unit_code": {
"id": "<string>",
"name": "<string>",
"code": "<string>"
}
}
]
}
]
}
],
"linked_sessions": [
{
"id": 123,
"session_order": 123,
"session_type": "<string>",
"treatment": {
"id": 123,
"name": "<string>",
"display_name": "<string>"
},
"products": [
{
"id": 123,
"quantity": 123,
"name": "<string>",
"full_name": "<string>",
"unit_code": {
"id": "<string>",
"name": "<string>",
"code": "<string>"
}
}
]
}
],
"tags": [
{
"id": 123,
"tenant_id": 123,
"name": "<string>",
"color": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"reminders": [
{
"id": 123,
"record_state": {
"is_read_only": true,
"reason_code": "<string>"
},
"appointment_id": 123,
"tenant_id": 123,
"type": "<string>",
"offset_days": 123,
"scheduled_for": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"channel": "<string>",
"message": "<string>",
"status": "<string>",
"approval_status": "<string>",
"approved_at": "2023-11-07T05:31:56Z",
"approved_by": 123,
"metadata": [
"<unknown>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"appointment": {
"id": 123,
"record_state": {
"is_read_only": true,
"reason_code": "<string>"
},
"code": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"relation_type": "<string>",
"parent_appointment_id": 123,
"customer": {
"id": 123,
"record_state": {
"is_read_only": true,
"reason_code": "<string>"
},
"first_name": "<string>",
"last_name": "<string>",
"phone_number": "<string>",
"email": "<string>",
"is_masked": true,
"is_lead_stage": true,
"lead_id": 123
},
"doctor": {
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
},
"treatments": [
{
"id": 123,
"name": "<string>",
"group": {
"id": 123,
"name": "<string>"
}
}
],
"parent_appointment": null
},
"approver": {
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
}
}
],
"customer_balance": {
"outstanding_balance": "<string>",
"overdue_balance": "<string>",
"currency_code": "<string>"
},
"import_source": {
"id": 123,
"name": "<string>",
"company_logo": null
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"success": true,
"error_code": "RESOURCE_NOT_FOUND",
"message": "<string>",
"errors": null,
"data": null
}{
"success": false,
"error_code": "CUSTOMER_ERASED",
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"success": false,
"error_code": "SETUP_REQUIRED",
"message": "Complete the required setup steps to continue.",
"data": {
"next_step": "clinic_info"
}
}Yetkilendirmeler
The access token received from the authorization server in the OAuth 2.0 flow.
Başlıklar
Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.
Yol Parametreleri
The appointment identifier
Gövde
The customer ID.
The user ID.
Whether this appointment overrides its treatments' normal session plan with a single control-type session per treatment. Cannot be changed after the appointment is created.
The assistant ID (deprecated, use assistant_ids).
The assistant IDs.
An assistant IDs value.
The parent appointment ID.
Filter by appointment relation type (parent or child).
parent, child, null The description.
65000The scheduled at.
Whether to send the appointment-updated notification to the customer when a date/time, doctor or treatment change is saved. Defaults to the tenant setting when omitted.
The channel the appointment notifications are sent on. Must be connected (GET /appointments/{id} → customer.notification_channels[].status = open); a closed or connecting channel is rejected. Send null to fall back to automatic resolution.
The customer's address on the chosen channel: phone number for WhatsApp, numeric chat ID for Telegram (usernames cannot be messaged), IGSID for Instagram. Required when the customer cannot be reached on channel_id yet; it is saved as a customer identity so the notification can be delivered.
255The appointment duration in minutes.
5 <= x <= 1440The status.
pending, approved, cancelled, rejected, completed, no_show, null The cancellation reason.
1000The room ID.
Tag identifiers to attach to the appointment.
A tag ID.
The treatments.
A treatments value.
The treatment session plans.
Show child attributes
Show child attributes