The Appointment Booking Settings object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

number_of_agents integer

Default: 1

holiday_list string required
appointment_duration integer

Default: 60

email_reminders boolean

Default: false

advance_booking_days integer

Default: 7

enable_scheduling boolean

Default: false

success_redirect_url string
The Appointment Booking Settings object 
{
  "id": "appointment-booking-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "number_of_agents": 1,
  "holiday_list": "holiday_list_example",
  "appointment_duration": 60,
  "email_reminders": false,
  "advance_booking_days": 7,
  "enable_scheduling": false,
  "success_redirect_url": "success_redirect_url_example"
}
GET /api/crm/appointment-booking-settings

Retrieve appointment booking settings

Retrieves the current appointment booking settings. This is a singleton resource.

Returns

Returns the appointment booking settings object.

GET /api/crm/appointment-booking-settings 
curl https://api.overplane.dev/api/crm/appointment-booking-settings \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "appointment-booking-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "number_of_agents": 1,
  "holiday_list": "holiday_list_example",
  "appointment_duration": 60,
  "email_reminders": false,
  "advance_booking_days": 7,
  "enable_scheduling": false,
  "success_redirect_url": "success_redirect_url_example"
}
PATCH /api/crm/appointment-booking-settings/{id}

Update a appointment booking settings

Updates the specified appointment booking settings by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the appointment booking settings to update.

Body parameters

number_of_agents integer

Default: 1

holiday_list string
appointment_duration integer

Default: 60

email_reminders boolean

Default: false

advance_booking_days integer

Default: 7

enable_scheduling boolean

Default: false

success_redirect_url string

Returns

Returns the updated appointment booking settings object.

PATCH /api/crm/appointment-booking-settings/{id} 
curl https://api.overplane.dev/api/crm/appointment-booking-settings/appointment-booking-settings_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"number_of_agents":1,"holiday_list":"holiday_list_example"}'
Response 
{
  "id": "appointment-booking-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "number_of_agents": 1,
  "holiday_list": "holiday_list_example",
  "appointment_duration": 60,
  "email_reminders": false,
  "advance_booking_days": 7,
  "enable_scheduling": false,
  "success_redirect_url": "success_redirect_url_example"
}

Line items

Child objects that belong to this appointment booking settings. These are accessed via the parent's ID.

Appointment Booking Slots

Attributes

idx integer
appointment_booking_settings_id string required
day_of_week string required
from_time string required
to_time string required

Endpoints

GET /api/crm/appointment-booking-slots?parent_id={id}
POST /api/crm/appointment-booking-slots
PATCH /api/crm/appointment-booking-slots/{id}
DELETE /api/crm/appointment-booking-slots/{id}
POST /api/crm/appointment-booking-slots/reorder
Appointment Booking Slots object 
{
  "id": "appointment-booking-slots_abc123",
  "idx": 1,
  "appointment_booking_settings_id": "appointment_booking_settings_id_example",
  "day_of_week": "day_of_week_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example"
}