A booking link is a public page where customers book your reservation services themselves. Each link has a slug, a mode that decides which services it shows, and a page_config with its branding, texts and form. The page is served at /b/{organization_id}/{slug} on the AchieveApex web app, and bookings made there are created as reservations.
Owning organization. Required on create; must be the API key's organization.
name
string
Internal name, max 255 characters. Required on create.
slug
string
URL segment of the public page. 3–64 characters: lowercase letters, numbers and dashes, starting with a letter or number (spaces become dashes, upper case is lowered). Unique per organization (including deleted links). Generated from name plus a random suffix when omitted on create.
mode
string
Which services the page shows: all_services (default), single_service or selected_services. See below.
service_id
integer | null
The service for single_service (required in that mode). Forced to null in the other modes.
is_active
boolean
Default true. Inactive links return "not active" on the public page.
page_config
object
Branding, texts, contact form and service layout. Default {}. See the reference below. Replaced as a whole on update.
settings
object
Free-form object stored with the link. Default {}. Not used by the public page.
tracking_config
object
Default {}. Analytics on the public page: meta_pixel_id (digits only, 5–20) and ga4_measurement_id (G-XXXXXXXXXX). Invalid IDs return 400. custom_head_code / custom_body_code are accepted by the schema but removed on save: booking pages never run custom code.
created_by_user_id
integer | null
Read-only. User who created the link; with an API key, the user the key belongs to.
created_at
string (date-time)
Read-only. Creation time.
updated_at
string (date-time)
Read-only. Last update time.
deleted_at
string (date-time) | null
Read-only. Set when the link is deleted.
mode
Value
Services shown
all_services
Every service with is_active: true and is_public: true. Order and group them with page_config.booking_all_services_order / booking_all_services_sections.
single_service
Only service_id.
selected_services
The services in page_config.booking_service_sections (grouped) or page_config.booking_service_ids. At least one is required, and all must belong to your organization.
Inactive or non-public services never appear, whatever the mode.
page_config reference
page_config is a free-form object used by the public booking page. All keys are optional. Colors are CSS hex strings (e.g. #2563EB). The server validates video_url and the service-selection keys; the rest is stored as sent.
Content and copy
Key
Type
Description
hero_title
String
Hero title override.
show_hero_title
Boolean
Default true if omitted.
hero_fallback_to_link_name
Boolean
Use link name when hero title empty.
hero_subtitle
String
description
String
Body/description.
instructions
String
Instructions shown on the flow.
thank_you_message
String
Post-booking message.
policy_text
String
Policy / legal footer.
booking_page_copy
Object
Partial string overrides for UI labels (see app BookingPageCopy).
booking_page_copy_preset
String
english or spanish presets in the UI.
Media and layout
Key
Type
Description
logo_url
String
Logo image URL.
cover_image_url
String
Hero cover image URL.
video_url
String
Intro video shown on the page (YouTube, Vimeo, Loom, Wistia, Google Drive, <iframe> embed code, direct video URL…). Unsupported links return 400.
video_title
String
Title above the video, trimmed to 200 characters.
booking_logo_placement
String
e.g. below_cover.
booking_logo_shape
String
e.g. rounded.
booking_logo_size
String
e.g. md.
booking_logo_background_color
String
booking_logo_border_color
String
booking_logo_border_width_px
Number
booking_logo_show_shadow
Boolean
booking_logo_show_ring
Boolean
booking_logo_ring_color
String
booking_logo_ring_width_px
Number
Theme and colors
Key
Type
Description
booking_page_theme
String
custom or preset mode from theme picker.
primary_color
String
background_color
String
text_color
String
heading_color
String
muted_text_color
String
link_color
String
on_primary_color
String
surface_color
String
surface_border_color
String
input_background_color
String
input_border_color
String
hero_title_text_color
String
hero_subtitle_text_color
String
service_icon_text_color
String
summary_banner_color
String
instruction_banner_color
String
instruction_banner_text_color
String
empty_state_background_color
String
empty_state_border_color
String
empty_state_text_color
String
slot_button_background_color
String
slot_button_idle_text_color
String
stepper_inactive_color
String
stepper_connector_color
String
stepper_text_color
String
service_list_background_color
String
service_list_border_color
String
service_list_heading_text_color
String
service_list_primary_text_color
String
service_list_secondary_text_color
String
calendar_panel_background_color
String
calendar_panel_border_color
String
calendar_section_heading_text_color
String
calendar_panel_text_color
String
times_panel_background_color
String
times_panel_border_color
String
times_section_heading_text_color
String
times_panel_secondary_text_color
String
times_panel_text_color
String
details_section_heading_text_color
String
customer_details_text_color
String
confirmation_title_text_color
String
confirmation_body_text_color
String
confirmation_recap_text_color
String
policy_footer_text_color
String
summary_strip_primary_text_color
String
summary_strip_secondary_text_color
String
Service list presentation
Key
Type
Description
service_list_thumbnail_mode
String
color, image, letter, or none.
service_list_layout
String
list or grid.
show_service_description
Boolean
Default true if omitted.
show_powered_by
Boolean
Contact form
Key
Type
Description
booking_contact_fields
Object
Flags for first_name, last_name, email, phone, party_size, notes.
booking_contact_identify_mode
String
email_first or phone_first.
booking_identify_show_heading
Boolean
booking_identify_show_helper
Boolean
booking_default_phone_country_iso
String
e.g. US.
booking_default_phone_country_code
String
e.g. +1.
booking_default_party_size
Number
booking_contact_custom_field_ids
Number[]
Contact custom field IDs to show.
booking_reservation_custom_field_ids
Number[]
Reservation custom field IDs to show.
Service selection (mode-dependent)
Key
Type
Description
booking_service_ids
Number[]
Services shown with selected_services when no sections are set.
booking_service_sections
Array
{ id, title, service_ids: number[] } groups for selected_services. When present, takes precedence over booking_service_ids.