Update Appointment Definition
curl --request PUT \
--url https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition} \
--header 'Content-Type: application/json' \
--data '
{
"booking_questionnaire": {
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"is_active": true,
"meta": [
"<string>"
],
"questions": [
{
"mapping_key": "<string>",
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"sort_order": 1,
"is_required": true,
"visibility_condition": [
"<string>"
],
"is_active": true
}
],
"pages": [
{
"title": "<string>",
"description": "<string>",
"image_url": "<string>",
"section_header": "<string>",
"sort_order": 1,
"questions": [
{
"mapping_key": "<string>",
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"sort_order": 1,
"is_required": true,
"visibility_condition": [
"<string>"
],
"is_active": true
}
]
}
]
},
"handle": "<string>",
"name": "<string>",
"description": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"terms_conditions": "<string>",
"internal_notes": "<string>",
"visibility_condition": [
"<string>"
],
"is_published": true,
"is_archived": true,
"duration_minutes": 2,
"buffer_before_minutes": 1,
"buffer_after_minutes": 1,
"min_lead_minutes": 1,
"max_advance_days": 2,
"slot_interval_minutes": 2,
"allow_customer_booking": true,
"allow_walk_in": true,
"requires_staff": true,
"customer_must_select_staff": true,
"use_staff_from_location": true,
"max_concurrent_bookings": 2,
"allow_waitlist": true,
"allow_queue": true,
"meta": [
"<string>"
],
"created_target_id": 123,
"confirmed_target_id": 123,
"cancelled_target_id": 123,
"rejected_target_id": 123,
"reminder_target_id": 123,
"completed_target_id": 123,
"notify_created_offset_days": 1,
"notify_created_offset_hours": 1,
"notify_confirmed_offset_days": 1,
"notify_confirmed_offset_hours": 1,
"notify_cancelled_offset_days": 1,
"notify_cancelled_offset_hours": 1,
"notify_rejected_offset_days": 1,
"notify_rejected_offset_hours": 1,
"notify_reminder_offset_days": 1,
"notify_reminder_offset_hours": 1,
"notify_completed_offset_days": 1,
"notify_completed_offset_hours": 1,
"location_ids": [
123
],
"staff_ids": [
"<string>"
],
"normal_hours": [
{
"available_from": "<string>",
"available_until": "<string>"
}
],
"special_hours": [
{
"name": "<string>",
"start_at": "<string>",
"end_at": "<string>",
"is_repeating": true,
"available_from": "<string>",
"available_until": "<string>"
}
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}"
payload = {
"booking_questionnaire": {
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"is_active": True,
"meta": ["<string>"],
"questions": [
{
"mapping_key": "<string>",
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"sort_order": 1,
"is_required": True,
"visibility_condition": ["<string>"],
"is_active": True
}
],
"pages": [
{
"title": "<string>",
"description": "<string>",
"image_url": "<string>",
"section_header": "<string>",
"sort_order": 1,
"questions": [
{
"mapping_key": "<string>",
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"sort_order": 1,
"is_required": True,
"visibility_condition": ["<string>"],
"is_active": True
}
]
}
]
},
"handle": "<string>",
"name": "<string>",
"description": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"terms_conditions": "<string>",
"internal_notes": "<string>",
"visibility_condition": ["<string>"],
"is_published": True,
"is_archived": True,
"duration_minutes": 2,
"buffer_before_minutes": 1,
"buffer_after_minutes": 1,
"min_lead_minutes": 1,
"max_advance_days": 2,
"slot_interval_minutes": 2,
"allow_customer_booking": True,
"allow_walk_in": True,
"requires_staff": True,
"customer_must_select_staff": True,
"use_staff_from_location": True,
"max_concurrent_bookings": 2,
"allow_waitlist": True,
"allow_queue": True,
"meta": ["<string>"],
"created_target_id": 123,
"confirmed_target_id": 123,
"cancelled_target_id": 123,
"rejected_target_id": 123,
"reminder_target_id": 123,
"completed_target_id": 123,
"notify_created_offset_days": 1,
"notify_created_offset_hours": 1,
"notify_confirmed_offset_days": 1,
"notify_confirmed_offset_hours": 1,
"notify_cancelled_offset_days": 1,
"notify_cancelled_offset_hours": 1,
"notify_rejected_offset_days": 1,
"notify_rejected_offset_hours": 1,
"notify_reminder_offset_days": 1,
"notify_reminder_offset_hours": 1,
"notify_completed_offset_days": 1,
"notify_completed_offset_hours": 1,
"location_ids": [123],
"staff_ids": ["<string>"],
"normal_hours": [
{
"available_from": "<string>",
"available_until": "<string>"
}
],
"special_hours": [
{
"name": "<string>",
"start_at": "<string>",
"end_at": "<string>",
"is_repeating": True,
"available_from": "<string>",
"available_until": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
booking_questionnaire: {
name: '<string>',
handle: '<string>',
description: '<string>',
is_active: true,
meta: ['<string>'],
questions: [
{
mapping_key: '<string>',
question_id: 123,
question_handle: '<string>',
question_version_id: 123,
sort_order: 1,
is_required: true,
visibility_condition: ['<string>'],
is_active: true
}
],
pages: [
{
title: '<string>',
description: '<string>',
image_url: '<string>',
section_header: '<string>',
sort_order: 1,
questions: [
{
mapping_key: '<string>',
question_id: 123,
question_handle: '<string>',
question_version_id: 123,
sort_order: 1,
is_required: true,
visibility_condition: ['<string>'],
is_active: true
}
]
}
]
},
handle: '<string>',
name: '<string>',
description: '<string>',
short_description: '<string>',
long_description: '<string>',
icon: '<string>',
image_url: '<string>',
terms_conditions: '<string>',
internal_notes: '<string>',
visibility_condition: ['<string>'],
is_published: true,
is_archived: true,
duration_minutes: 2,
buffer_before_minutes: 1,
buffer_after_minutes: 1,
min_lead_minutes: 1,
max_advance_days: 2,
slot_interval_minutes: 2,
allow_customer_booking: true,
allow_walk_in: true,
requires_staff: true,
customer_must_select_staff: true,
use_staff_from_location: true,
max_concurrent_bookings: 2,
allow_waitlist: true,
allow_queue: true,
meta: ['<string>'],
created_target_id: 123,
confirmed_target_id: 123,
cancelled_target_id: 123,
rejected_target_id: 123,
reminder_target_id: 123,
completed_target_id: 123,
notify_created_offset_days: 1,
notify_created_offset_hours: 1,
notify_confirmed_offset_days: 1,
notify_confirmed_offset_hours: 1,
notify_cancelled_offset_days: 1,
notify_cancelled_offset_hours: 1,
notify_rejected_offset_days: 1,
notify_rejected_offset_hours: 1,
notify_reminder_offset_days: 1,
notify_reminder_offset_hours: 1,
notify_completed_offset_days: 1,
notify_completed_offset_hours: 1,
location_ids: [123],
staff_ids: ['<string>'],
normal_hours: [{available_from: '<string>', available_until: '<string>'}],
special_hours: [
{
name: '<string>',
start_at: '<string>',
end_at: '<string>',
is_repeating: true,
available_from: '<string>',
available_until: '<string>'
}
]
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}', 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.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}",
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([
'booking_questionnaire' => [
'name' => '<string>',
'handle' => '<string>',
'description' => '<string>',
'is_active' => true,
'meta' => [
'<string>'
],
'questions' => [
[
'mapping_key' => '<string>',
'question_id' => 123,
'question_handle' => '<string>',
'question_version_id' => 123,
'sort_order' => 1,
'is_required' => true,
'visibility_condition' => [
'<string>'
],
'is_active' => true
]
],
'pages' => [
[
'title' => '<string>',
'description' => '<string>',
'image_url' => '<string>',
'section_header' => '<string>',
'sort_order' => 1,
'questions' => [
[
'mapping_key' => '<string>',
'question_id' => 123,
'question_handle' => '<string>',
'question_version_id' => 123,
'sort_order' => 1,
'is_required' => true,
'visibility_condition' => [
'<string>'
],
'is_active' => true
]
]
]
]
],
'handle' => '<string>',
'name' => '<string>',
'description' => '<string>',
'short_description' => '<string>',
'long_description' => '<string>',
'icon' => '<string>',
'image_url' => '<string>',
'terms_conditions' => '<string>',
'internal_notes' => '<string>',
'visibility_condition' => [
'<string>'
],
'is_published' => true,
'is_archived' => true,
'duration_minutes' => 2,
'buffer_before_minutes' => 1,
'buffer_after_minutes' => 1,
'min_lead_minutes' => 1,
'max_advance_days' => 2,
'slot_interval_minutes' => 2,
'allow_customer_booking' => true,
'allow_walk_in' => true,
'requires_staff' => true,
'customer_must_select_staff' => true,
'use_staff_from_location' => true,
'max_concurrent_bookings' => 2,
'allow_waitlist' => true,
'allow_queue' => true,
'meta' => [
'<string>'
],
'created_target_id' => 123,
'confirmed_target_id' => 123,
'cancelled_target_id' => 123,
'rejected_target_id' => 123,
'reminder_target_id' => 123,
'completed_target_id' => 123,
'notify_created_offset_days' => 1,
'notify_created_offset_hours' => 1,
'notify_confirmed_offset_days' => 1,
'notify_confirmed_offset_hours' => 1,
'notify_cancelled_offset_days' => 1,
'notify_cancelled_offset_hours' => 1,
'notify_rejected_offset_days' => 1,
'notify_rejected_offset_hours' => 1,
'notify_reminder_offset_days' => 1,
'notify_reminder_offset_hours' => 1,
'notify_completed_offset_days' => 1,
'notify_completed_offset_hours' => 1,
'location_ids' => [
123
],
'staff_ids' => [
'<string>'
],
'normal_hours' => [
[
'available_from' => '<string>',
'available_until' => '<string>'
]
],
'special_hours' => [
[
'name' => '<string>',
'start_at' => '<string>',
'end_at' => '<string>',
'is_repeating' => true,
'available_from' => '<string>',
'available_until' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"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.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}"
payload := strings.NewReader("{\n \"booking_questionnaire\": {\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"mapping_key\": \"<string>\",\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ],\n \"pages\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"section_header\": \"<string>\",\n \"sort_order\": 1,\n \"questions\": [\n {\n \"mapping_key\": \"<string>\",\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ]\n }\n ]\n },\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"terms_conditions\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_published\": true,\n \"is_archived\": true,\n \"duration_minutes\": 2,\n \"buffer_before_minutes\": 1,\n \"buffer_after_minutes\": 1,\n \"min_lead_minutes\": 1,\n \"max_advance_days\": 2,\n \"slot_interval_minutes\": 2,\n \"allow_customer_booking\": true,\n \"allow_walk_in\": true,\n \"requires_staff\": true,\n \"customer_must_select_staff\": true,\n \"use_staff_from_location\": true,\n \"max_concurrent_bookings\": 2,\n \"allow_waitlist\": true,\n \"allow_queue\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"created_target_id\": 123,\n \"confirmed_target_id\": 123,\n \"cancelled_target_id\": 123,\n \"rejected_target_id\": 123,\n \"reminder_target_id\": 123,\n \"completed_target_id\": 123,\n \"notify_created_offset_days\": 1,\n \"notify_created_offset_hours\": 1,\n \"notify_confirmed_offset_days\": 1,\n \"notify_confirmed_offset_hours\": 1,\n \"notify_cancelled_offset_days\": 1,\n \"notify_cancelled_offset_hours\": 1,\n \"notify_rejected_offset_days\": 1,\n \"notify_rejected_offset_hours\": 1,\n \"notify_reminder_offset_days\": 1,\n \"notify_reminder_offset_hours\": 1,\n \"notify_completed_offset_days\": 1,\n \"notify_completed_offset_hours\": 1,\n \"location_ids\": [\n 123\n ],\n \"staff_ids\": [\n \"<string>\"\n ],\n \"normal_hours\": [\n {\n \"available_from\": \"<string>\",\n \"available_until\": \"<string>\"\n }\n ],\n \"special_hours\": [\n {\n \"name\": \"<string>\",\n \"start_at\": \"<string>\",\n \"end_at\": \"<string>\",\n \"is_repeating\": true,\n \"available_from\": \"<string>\",\n \"available_until\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
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://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}")
.header("Content-Type", "application/json")
.body("{\n \"booking_questionnaire\": {\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"mapping_key\": \"<string>\",\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ],\n \"pages\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"section_header\": \"<string>\",\n \"sort_order\": 1,\n \"questions\": [\n {\n \"mapping_key\": \"<string>\",\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ]\n }\n ]\n },\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"terms_conditions\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_published\": true,\n \"is_archived\": true,\n \"duration_minutes\": 2,\n \"buffer_before_minutes\": 1,\n \"buffer_after_minutes\": 1,\n \"min_lead_minutes\": 1,\n \"max_advance_days\": 2,\n \"slot_interval_minutes\": 2,\n \"allow_customer_booking\": true,\n \"allow_walk_in\": true,\n \"requires_staff\": true,\n \"customer_must_select_staff\": true,\n \"use_staff_from_location\": true,\n \"max_concurrent_bookings\": 2,\n \"allow_waitlist\": true,\n \"allow_queue\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"created_target_id\": 123,\n \"confirmed_target_id\": 123,\n \"cancelled_target_id\": 123,\n \"rejected_target_id\": 123,\n \"reminder_target_id\": 123,\n \"completed_target_id\": 123,\n \"notify_created_offset_days\": 1,\n \"notify_created_offset_hours\": 1,\n \"notify_confirmed_offset_days\": 1,\n \"notify_confirmed_offset_hours\": 1,\n \"notify_cancelled_offset_days\": 1,\n \"notify_cancelled_offset_hours\": 1,\n \"notify_rejected_offset_days\": 1,\n \"notify_rejected_offset_hours\": 1,\n \"notify_reminder_offset_days\": 1,\n \"notify_reminder_offset_hours\": 1,\n \"notify_completed_offset_days\": 1,\n \"notify_completed_offset_hours\": 1,\n \"location_ids\": [\n 123\n ],\n \"staff_ids\": [\n \"<string>\"\n ],\n \"normal_hours\": [\n {\n \"available_from\": \"<string>\",\n \"available_until\": \"<string>\"\n }\n ],\n \"special_hours\": [\n {\n \"name\": \"<string>\",\n \"start_at\": \"<string>\",\n \"end_at\": \"<string>\",\n \"is_repeating\": true,\n \"available_from\": \"<string>\",\n \"available_until\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"booking_questionnaire\": {\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"mapping_key\": \"<string>\",\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ],\n \"pages\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"section_header\": \"<string>\",\n \"sort_order\": 1,\n \"questions\": [\n {\n \"mapping_key\": \"<string>\",\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ]\n }\n ]\n },\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"terms_conditions\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_published\": true,\n \"is_archived\": true,\n \"duration_minutes\": 2,\n \"buffer_before_minutes\": 1,\n \"buffer_after_minutes\": 1,\n \"min_lead_minutes\": 1,\n \"max_advance_days\": 2,\n \"slot_interval_minutes\": 2,\n \"allow_customer_booking\": true,\n \"allow_walk_in\": true,\n \"requires_staff\": true,\n \"customer_must_select_staff\": true,\n \"use_staff_from_location\": true,\n \"max_concurrent_bookings\": 2,\n \"allow_waitlist\": true,\n \"allow_queue\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"created_target_id\": 123,\n \"confirmed_target_id\": 123,\n \"cancelled_target_id\": 123,\n \"rejected_target_id\": 123,\n \"reminder_target_id\": 123,\n \"completed_target_id\": 123,\n \"notify_created_offset_days\": 1,\n \"notify_created_offset_hours\": 1,\n \"notify_confirmed_offset_days\": 1,\n \"notify_confirmed_offset_hours\": 1,\n \"notify_cancelled_offset_days\": 1,\n \"notify_cancelled_offset_hours\": 1,\n \"notify_rejected_offset_days\": 1,\n \"notify_rejected_offset_hours\": 1,\n \"notify_reminder_offset_days\": 1,\n \"notify_reminder_offset_hours\": 1,\n \"notify_completed_offset_days\": 1,\n \"notify_completed_offset_hours\": 1,\n \"location_ids\": [\n 123\n ],\n \"staff_ids\": [\n \"<string>\"\n ],\n \"normal_hours\": [\n {\n \"available_from\": \"<string>\",\n \"available_until\": \"<string>\"\n }\n ],\n \"special_hours\": [\n {\n \"name\": \"<string>\",\n \"start_at\": \"<string>\",\n \"end_at\": \"<string>\",\n \"is_repeating\": true,\n \"available_from\": \"<string>\",\n \"available_until\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"handle": "<string>",
"name": "<string>",
"description": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"terms_conditions": "<string>",
"internal_notes": "<string>",
"visibility_condition": [
"<unknown>"
],
"is_published": true,
"is_archived": true,
"duration_minutes": 123,
"buffer_before_minutes": 123,
"buffer_after_minutes": 123,
"min_lead_minutes": 123,
"max_advance_days": 123,
"slot_interval_minutes": 123,
"booking_type": "<string>",
"allow_customer_booking": true,
"allow_walk_in": true,
"requires_staff": true,
"customer_must_select_staff": true,
"use_staff_from_location": true,
"max_concurrent_bookings": 123,
"allow_waitlist": true,
"allow_queue": true,
"meta": [
"<unknown>"
],
"created_target_id": 123,
"confirmed_target_id": 123,
"cancelled_target_id": 123,
"rejected_target_id": 123,
"reminder_target_id": 123,
"completed_target_id": 123,
"notify_created_offset_days": 123,
"notify_created_offset_hours": 123,
"notify_confirmed_offset_days": 123,
"notify_confirmed_offset_hours": 123,
"notify_cancelled_offset_days": 123,
"notify_cancelled_offset_hours": 123,
"notify_rejected_offset_days": 123,
"notify_rejected_offset_hours": 123,
"notify_reminder_offset_days": 123,
"notify_reminder_offset_hours": 123,
"notify_completed_offset_days": 123,
"notify_completed_offset_hours": 123,
"has_booking_questionnaire": true,
"created_at": "<string>",
"updated_at": "<string>",
"normal_hours": [
{
"id": 123,
"appointment_definition_id": 123,
"day_of_week": "<string>",
"available_from": "<string>",
"available_until": "<string>",
"is_closed": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
],
"special_hours": [
{
"id": 123,
"appointment_definition_id": 123,
"name": "<string>",
"is_repeating": true,
"available_from": "<string>",
"available_until": "<string>",
"start_at": "<string>",
"end_at": "<string>",
"is_closed": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
],
"locations": [
"<unknown>"
],
"staff": [
{
"id": 123,
"appointment_definition_id": 123,
"staff_id": "<string>",
"is_active": true,
"staff": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"mobile_phone": "<string>",
"normal_hours": [
{
"id": "<string>",
"day_of_week": "<string>",
"available_from": "<string>",
"available_until": "<string>",
"is_closed": "<string>"
}
],
"special_hours": [
{
"id": "<string>",
"name": "<string>",
"is_repeating": "<string>",
"available_from": "<string>",
"available_until": "<string>",
"start_at": "<string>",
"end_at": "<string>"
}
]
},
"created_at": "<string>",
"updated_at": "<string>"
}
],
"booking_questionnaire": {
"id": "<string>",
"name": "<string>",
"purpose": "<string>",
"is_active": "<string>",
"pages": "<string>"
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Appointment Definition
Update Appointment Definition
A PUT to the /appointment-definitions/{appointmentDefinitionId} endpoint allows your application to update a specific appointment definition record.
PUT
/
v3
/
appointment-definitions
/
{appointmentDefinition}
Update Appointment Definition
curl --request PUT \
--url https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition} \
--header 'Content-Type: application/json' \
--data '
{
"booking_questionnaire": {
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"is_active": true,
"meta": [
"<string>"
],
"questions": [
{
"mapping_key": "<string>",
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"sort_order": 1,
"is_required": true,
"visibility_condition": [
"<string>"
],
"is_active": true
}
],
"pages": [
{
"title": "<string>",
"description": "<string>",
"image_url": "<string>",
"section_header": "<string>",
"sort_order": 1,
"questions": [
{
"mapping_key": "<string>",
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"sort_order": 1,
"is_required": true,
"visibility_condition": [
"<string>"
],
"is_active": true
}
]
}
]
},
"handle": "<string>",
"name": "<string>",
"description": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"terms_conditions": "<string>",
"internal_notes": "<string>",
"visibility_condition": [
"<string>"
],
"is_published": true,
"is_archived": true,
"duration_minutes": 2,
"buffer_before_minutes": 1,
"buffer_after_minutes": 1,
"min_lead_minutes": 1,
"max_advance_days": 2,
"slot_interval_minutes": 2,
"allow_customer_booking": true,
"allow_walk_in": true,
"requires_staff": true,
"customer_must_select_staff": true,
"use_staff_from_location": true,
"max_concurrent_bookings": 2,
"allow_waitlist": true,
"allow_queue": true,
"meta": [
"<string>"
],
"created_target_id": 123,
"confirmed_target_id": 123,
"cancelled_target_id": 123,
"rejected_target_id": 123,
"reminder_target_id": 123,
"completed_target_id": 123,
"notify_created_offset_days": 1,
"notify_created_offset_hours": 1,
"notify_confirmed_offset_days": 1,
"notify_confirmed_offset_hours": 1,
"notify_cancelled_offset_days": 1,
"notify_cancelled_offset_hours": 1,
"notify_rejected_offset_days": 1,
"notify_rejected_offset_hours": 1,
"notify_reminder_offset_days": 1,
"notify_reminder_offset_hours": 1,
"notify_completed_offset_days": 1,
"notify_completed_offset_hours": 1,
"location_ids": [
123
],
"staff_ids": [
"<string>"
],
"normal_hours": [
{
"available_from": "<string>",
"available_until": "<string>"
}
],
"special_hours": [
{
"name": "<string>",
"start_at": "<string>",
"end_at": "<string>",
"is_repeating": true,
"available_from": "<string>",
"available_until": "<string>"
}
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}"
payload = {
"booking_questionnaire": {
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"is_active": True,
"meta": ["<string>"],
"questions": [
{
"mapping_key": "<string>",
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"sort_order": 1,
"is_required": True,
"visibility_condition": ["<string>"],
"is_active": True
}
],
"pages": [
{
"title": "<string>",
"description": "<string>",
"image_url": "<string>",
"section_header": "<string>",
"sort_order": 1,
"questions": [
{
"mapping_key": "<string>",
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"sort_order": 1,
"is_required": True,
"visibility_condition": ["<string>"],
"is_active": True
}
]
}
]
},
"handle": "<string>",
"name": "<string>",
"description": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"terms_conditions": "<string>",
"internal_notes": "<string>",
"visibility_condition": ["<string>"],
"is_published": True,
"is_archived": True,
"duration_minutes": 2,
"buffer_before_minutes": 1,
"buffer_after_minutes": 1,
"min_lead_minutes": 1,
"max_advance_days": 2,
"slot_interval_minutes": 2,
"allow_customer_booking": True,
"allow_walk_in": True,
"requires_staff": True,
"customer_must_select_staff": True,
"use_staff_from_location": True,
"max_concurrent_bookings": 2,
"allow_waitlist": True,
"allow_queue": True,
"meta": ["<string>"],
"created_target_id": 123,
"confirmed_target_id": 123,
"cancelled_target_id": 123,
"rejected_target_id": 123,
"reminder_target_id": 123,
"completed_target_id": 123,
"notify_created_offset_days": 1,
"notify_created_offset_hours": 1,
"notify_confirmed_offset_days": 1,
"notify_confirmed_offset_hours": 1,
"notify_cancelled_offset_days": 1,
"notify_cancelled_offset_hours": 1,
"notify_rejected_offset_days": 1,
"notify_rejected_offset_hours": 1,
"notify_reminder_offset_days": 1,
"notify_reminder_offset_hours": 1,
"notify_completed_offset_days": 1,
"notify_completed_offset_hours": 1,
"location_ids": [123],
"staff_ids": ["<string>"],
"normal_hours": [
{
"available_from": "<string>",
"available_until": "<string>"
}
],
"special_hours": [
{
"name": "<string>",
"start_at": "<string>",
"end_at": "<string>",
"is_repeating": True,
"available_from": "<string>",
"available_until": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
booking_questionnaire: {
name: '<string>',
handle: '<string>',
description: '<string>',
is_active: true,
meta: ['<string>'],
questions: [
{
mapping_key: '<string>',
question_id: 123,
question_handle: '<string>',
question_version_id: 123,
sort_order: 1,
is_required: true,
visibility_condition: ['<string>'],
is_active: true
}
],
pages: [
{
title: '<string>',
description: '<string>',
image_url: '<string>',
section_header: '<string>',
sort_order: 1,
questions: [
{
mapping_key: '<string>',
question_id: 123,
question_handle: '<string>',
question_version_id: 123,
sort_order: 1,
is_required: true,
visibility_condition: ['<string>'],
is_active: true
}
]
}
]
},
handle: '<string>',
name: '<string>',
description: '<string>',
short_description: '<string>',
long_description: '<string>',
icon: '<string>',
image_url: '<string>',
terms_conditions: '<string>',
internal_notes: '<string>',
visibility_condition: ['<string>'],
is_published: true,
is_archived: true,
duration_minutes: 2,
buffer_before_minutes: 1,
buffer_after_minutes: 1,
min_lead_minutes: 1,
max_advance_days: 2,
slot_interval_minutes: 2,
allow_customer_booking: true,
allow_walk_in: true,
requires_staff: true,
customer_must_select_staff: true,
use_staff_from_location: true,
max_concurrent_bookings: 2,
allow_waitlist: true,
allow_queue: true,
meta: ['<string>'],
created_target_id: 123,
confirmed_target_id: 123,
cancelled_target_id: 123,
rejected_target_id: 123,
reminder_target_id: 123,
completed_target_id: 123,
notify_created_offset_days: 1,
notify_created_offset_hours: 1,
notify_confirmed_offset_days: 1,
notify_confirmed_offset_hours: 1,
notify_cancelled_offset_days: 1,
notify_cancelled_offset_hours: 1,
notify_rejected_offset_days: 1,
notify_rejected_offset_hours: 1,
notify_reminder_offset_days: 1,
notify_reminder_offset_hours: 1,
notify_completed_offset_days: 1,
notify_completed_offset_hours: 1,
location_ids: [123],
staff_ids: ['<string>'],
normal_hours: [{available_from: '<string>', available_until: '<string>'}],
special_hours: [
{
name: '<string>',
start_at: '<string>',
end_at: '<string>',
is_repeating: true,
available_from: '<string>',
available_until: '<string>'
}
]
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}', 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.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}",
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([
'booking_questionnaire' => [
'name' => '<string>',
'handle' => '<string>',
'description' => '<string>',
'is_active' => true,
'meta' => [
'<string>'
],
'questions' => [
[
'mapping_key' => '<string>',
'question_id' => 123,
'question_handle' => '<string>',
'question_version_id' => 123,
'sort_order' => 1,
'is_required' => true,
'visibility_condition' => [
'<string>'
],
'is_active' => true
]
],
'pages' => [
[
'title' => '<string>',
'description' => '<string>',
'image_url' => '<string>',
'section_header' => '<string>',
'sort_order' => 1,
'questions' => [
[
'mapping_key' => '<string>',
'question_id' => 123,
'question_handle' => '<string>',
'question_version_id' => 123,
'sort_order' => 1,
'is_required' => true,
'visibility_condition' => [
'<string>'
],
'is_active' => true
]
]
]
]
],
'handle' => '<string>',
'name' => '<string>',
'description' => '<string>',
'short_description' => '<string>',
'long_description' => '<string>',
'icon' => '<string>',
'image_url' => '<string>',
'terms_conditions' => '<string>',
'internal_notes' => '<string>',
'visibility_condition' => [
'<string>'
],
'is_published' => true,
'is_archived' => true,
'duration_minutes' => 2,
'buffer_before_minutes' => 1,
'buffer_after_minutes' => 1,
'min_lead_minutes' => 1,
'max_advance_days' => 2,
'slot_interval_minutes' => 2,
'allow_customer_booking' => true,
'allow_walk_in' => true,
'requires_staff' => true,
'customer_must_select_staff' => true,
'use_staff_from_location' => true,
'max_concurrent_bookings' => 2,
'allow_waitlist' => true,
'allow_queue' => true,
'meta' => [
'<string>'
],
'created_target_id' => 123,
'confirmed_target_id' => 123,
'cancelled_target_id' => 123,
'rejected_target_id' => 123,
'reminder_target_id' => 123,
'completed_target_id' => 123,
'notify_created_offset_days' => 1,
'notify_created_offset_hours' => 1,
'notify_confirmed_offset_days' => 1,
'notify_confirmed_offset_hours' => 1,
'notify_cancelled_offset_days' => 1,
'notify_cancelled_offset_hours' => 1,
'notify_rejected_offset_days' => 1,
'notify_rejected_offset_hours' => 1,
'notify_reminder_offset_days' => 1,
'notify_reminder_offset_hours' => 1,
'notify_completed_offset_days' => 1,
'notify_completed_offset_hours' => 1,
'location_ids' => [
123
],
'staff_ids' => [
'<string>'
],
'normal_hours' => [
[
'available_from' => '<string>',
'available_until' => '<string>'
]
],
'special_hours' => [
[
'name' => '<string>',
'start_at' => '<string>',
'end_at' => '<string>',
'is_repeating' => true,
'available_from' => '<string>',
'available_until' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"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.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}"
payload := strings.NewReader("{\n \"booking_questionnaire\": {\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"mapping_key\": \"<string>\",\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ],\n \"pages\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"section_header\": \"<string>\",\n \"sort_order\": 1,\n \"questions\": [\n {\n \"mapping_key\": \"<string>\",\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ]\n }\n ]\n },\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"terms_conditions\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_published\": true,\n \"is_archived\": true,\n \"duration_minutes\": 2,\n \"buffer_before_minutes\": 1,\n \"buffer_after_minutes\": 1,\n \"min_lead_minutes\": 1,\n \"max_advance_days\": 2,\n \"slot_interval_minutes\": 2,\n \"allow_customer_booking\": true,\n \"allow_walk_in\": true,\n \"requires_staff\": true,\n \"customer_must_select_staff\": true,\n \"use_staff_from_location\": true,\n \"max_concurrent_bookings\": 2,\n \"allow_waitlist\": true,\n \"allow_queue\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"created_target_id\": 123,\n \"confirmed_target_id\": 123,\n \"cancelled_target_id\": 123,\n \"rejected_target_id\": 123,\n \"reminder_target_id\": 123,\n \"completed_target_id\": 123,\n \"notify_created_offset_days\": 1,\n \"notify_created_offset_hours\": 1,\n \"notify_confirmed_offset_days\": 1,\n \"notify_confirmed_offset_hours\": 1,\n \"notify_cancelled_offset_days\": 1,\n \"notify_cancelled_offset_hours\": 1,\n \"notify_rejected_offset_days\": 1,\n \"notify_rejected_offset_hours\": 1,\n \"notify_reminder_offset_days\": 1,\n \"notify_reminder_offset_hours\": 1,\n \"notify_completed_offset_days\": 1,\n \"notify_completed_offset_hours\": 1,\n \"location_ids\": [\n 123\n ],\n \"staff_ids\": [\n \"<string>\"\n ],\n \"normal_hours\": [\n {\n \"available_from\": \"<string>\",\n \"available_until\": \"<string>\"\n }\n ],\n \"special_hours\": [\n {\n \"name\": \"<string>\",\n \"start_at\": \"<string>\",\n \"end_at\": \"<string>\",\n \"is_repeating\": true,\n \"available_from\": \"<string>\",\n \"available_until\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
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://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}")
.header("Content-Type", "application/json")
.body("{\n \"booking_questionnaire\": {\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"mapping_key\": \"<string>\",\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ],\n \"pages\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"section_header\": \"<string>\",\n \"sort_order\": 1,\n \"questions\": [\n {\n \"mapping_key\": \"<string>\",\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ]\n }\n ]\n },\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"terms_conditions\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_published\": true,\n \"is_archived\": true,\n \"duration_minutes\": 2,\n \"buffer_before_minutes\": 1,\n \"buffer_after_minutes\": 1,\n \"min_lead_minutes\": 1,\n \"max_advance_days\": 2,\n \"slot_interval_minutes\": 2,\n \"allow_customer_booking\": true,\n \"allow_walk_in\": true,\n \"requires_staff\": true,\n \"customer_must_select_staff\": true,\n \"use_staff_from_location\": true,\n \"max_concurrent_bookings\": 2,\n \"allow_waitlist\": true,\n \"allow_queue\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"created_target_id\": 123,\n \"confirmed_target_id\": 123,\n \"cancelled_target_id\": 123,\n \"rejected_target_id\": 123,\n \"reminder_target_id\": 123,\n \"completed_target_id\": 123,\n \"notify_created_offset_days\": 1,\n \"notify_created_offset_hours\": 1,\n \"notify_confirmed_offset_days\": 1,\n \"notify_confirmed_offset_hours\": 1,\n \"notify_cancelled_offset_days\": 1,\n \"notify_cancelled_offset_hours\": 1,\n \"notify_rejected_offset_days\": 1,\n \"notify_rejected_offset_hours\": 1,\n \"notify_reminder_offset_days\": 1,\n \"notify_reminder_offset_hours\": 1,\n \"notify_completed_offset_days\": 1,\n \"notify_completed_offset_hours\": 1,\n \"location_ids\": [\n 123\n ],\n \"staff_ids\": [\n \"<string>\"\n ],\n \"normal_hours\": [\n {\n \"available_from\": \"<string>\",\n \"available_until\": \"<string>\"\n }\n ],\n \"special_hours\": [\n {\n \"name\": \"<string>\",\n \"start_at\": \"<string>\",\n \"end_at\": \"<string>\",\n \"is_repeating\": true,\n \"available_from\": \"<string>\",\n \"available_until\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"booking_questionnaire\": {\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"mapping_key\": \"<string>\",\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ],\n \"pages\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"section_header\": \"<string>\",\n \"sort_order\": 1,\n \"questions\": [\n {\n \"mapping_key\": \"<string>\",\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ]\n }\n ]\n },\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"terms_conditions\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_published\": true,\n \"is_archived\": true,\n \"duration_minutes\": 2,\n \"buffer_before_minutes\": 1,\n \"buffer_after_minutes\": 1,\n \"min_lead_minutes\": 1,\n \"max_advance_days\": 2,\n \"slot_interval_minutes\": 2,\n \"allow_customer_booking\": true,\n \"allow_walk_in\": true,\n \"requires_staff\": true,\n \"customer_must_select_staff\": true,\n \"use_staff_from_location\": true,\n \"max_concurrent_bookings\": 2,\n \"allow_waitlist\": true,\n \"allow_queue\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"created_target_id\": 123,\n \"confirmed_target_id\": 123,\n \"cancelled_target_id\": 123,\n \"rejected_target_id\": 123,\n \"reminder_target_id\": 123,\n \"completed_target_id\": 123,\n \"notify_created_offset_days\": 1,\n \"notify_created_offset_hours\": 1,\n \"notify_confirmed_offset_days\": 1,\n \"notify_confirmed_offset_hours\": 1,\n \"notify_cancelled_offset_days\": 1,\n \"notify_cancelled_offset_hours\": 1,\n \"notify_rejected_offset_days\": 1,\n \"notify_rejected_offset_hours\": 1,\n \"notify_reminder_offset_days\": 1,\n \"notify_reminder_offset_hours\": 1,\n \"notify_completed_offset_days\": 1,\n \"notify_completed_offset_hours\": 1,\n \"location_ids\": [\n 123\n ],\n \"staff_ids\": [\n \"<string>\"\n ],\n \"normal_hours\": [\n {\n \"available_from\": \"<string>\",\n \"available_until\": \"<string>\"\n }\n ],\n \"special_hours\": [\n {\n \"name\": \"<string>\",\n \"start_at\": \"<string>\",\n \"end_at\": \"<string>\",\n \"is_repeating\": true,\n \"available_from\": \"<string>\",\n \"available_until\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"handle": "<string>",
"name": "<string>",
"description": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"terms_conditions": "<string>",
"internal_notes": "<string>",
"visibility_condition": [
"<unknown>"
],
"is_published": true,
"is_archived": true,
"duration_minutes": 123,
"buffer_before_minutes": 123,
"buffer_after_minutes": 123,
"min_lead_minutes": 123,
"max_advance_days": 123,
"slot_interval_minutes": 123,
"booking_type": "<string>",
"allow_customer_booking": true,
"allow_walk_in": true,
"requires_staff": true,
"customer_must_select_staff": true,
"use_staff_from_location": true,
"max_concurrent_bookings": 123,
"allow_waitlist": true,
"allow_queue": true,
"meta": [
"<unknown>"
],
"created_target_id": 123,
"confirmed_target_id": 123,
"cancelled_target_id": 123,
"rejected_target_id": 123,
"reminder_target_id": 123,
"completed_target_id": 123,
"notify_created_offset_days": 123,
"notify_created_offset_hours": 123,
"notify_confirmed_offset_days": 123,
"notify_confirmed_offset_hours": 123,
"notify_cancelled_offset_days": 123,
"notify_cancelled_offset_hours": 123,
"notify_rejected_offset_days": 123,
"notify_rejected_offset_hours": 123,
"notify_reminder_offset_days": 123,
"notify_reminder_offset_hours": 123,
"notify_completed_offset_days": 123,
"notify_completed_offset_hours": 123,
"has_booking_questionnaire": true,
"created_at": "<string>",
"updated_at": "<string>",
"normal_hours": [
{
"id": 123,
"appointment_definition_id": 123,
"day_of_week": "<string>",
"available_from": "<string>",
"available_until": "<string>",
"is_closed": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
],
"special_hours": [
{
"id": 123,
"appointment_definition_id": 123,
"name": "<string>",
"is_repeating": true,
"available_from": "<string>",
"available_until": "<string>",
"start_at": "<string>",
"end_at": "<string>",
"is_closed": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
],
"locations": [
"<unknown>"
],
"staff": [
{
"id": 123,
"appointment_definition_id": 123,
"staff_id": "<string>",
"is_active": true,
"staff": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"mobile_phone": "<string>",
"normal_hours": [
{
"id": "<string>",
"day_of_week": "<string>",
"available_from": "<string>",
"available_until": "<string>",
"is_closed": "<string>"
}
],
"special_hours": [
{
"id": "<string>",
"name": "<string>",
"is_repeating": "<string>",
"available_from": "<string>",
"available_until": "<string>",
"start_at": "<string>",
"end_at": "<string>"
}
]
},
"created_at": "<string>",
"updated_at": "<string>"
}
],
"booking_questionnaire": {
"id": "<string>",
"name": "<string>",
"purpose": "<string>",
"is_active": "<string>",
"pages": "<string>"
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Path Parameters
The appointment definition ID
Body
application/json
Show child attributes
Show child attributes
Maximum string length:
255Maximum string length:
255Required range:
x >= 1Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 1Required range:
x >= 1Available options:
instant, approval_required, walk_in_only Required range:
x >= 1Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
AppointmentDefinition
Show child attributes
Show child attributes
⌘I