Reservation booking links

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.

Endpoints

MethodPathDescription
GET/reservation-booking-linksList booking links
GET/reservation-booking-links/:idGet a booking link
POST/reservation-booking-linksCreate a booking link
PATCH/reservation-booking-links/:idUpdate a booking link
DELETE/reservation-booking-links/:idDelete a booking link

The booking link object

json

Fields

FieldTypeDescription
idintegerRead-only. Unique ID.
organization_idintegerOwning organization. Required on create; must be the API key's organization.
namestringInternal name, max 255 characters. Required on create.
slugstringURL 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.
modestringWhich services the page shows: all_services (default), single_service or selected_services. See below.
service_idinteger | nullThe service for single_service (required in that mode). Forced to null in the other modes.
is_activebooleanDefault true. Inactive links return "not active" on the public page.
page_configobjectBranding, texts, contact form and service layout. Default {}. See the reference below. Replaced as a whole on update.
settingsobjectFree-form object stored with the link. Default {}. Not used by the public page.
tracking_configobjectDefault {}. 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_idinteger | nullRead-only. User who created the link; with an API key, the user the key belongs to.
created_atstring (date-time)Read-only. Creation time.
updated_atstring (date-time)Read-only. Last update time.
deleted_atstring (date-time) | nullRead-only. Set when the link is deleted.

mode

ValueServices shown
all_servicesEvery 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_serviceOnly service_id.
selected_servicesThe 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

KeyTypeDescription
hero_titleStringHero title override.
show_hero_titleBooleanDefault true if omitted.
hero_fallback_to_link_nameBooleanUse link name when hero title empty.
hero_subtitleString
descriptionStringBody/description.
instructionsStringInstructions shown on the flow.
thank_you_messageStringPost-booking message.
policy_textStringPolicy / legal footer.
booking_page_copyObjectPartial string overrides for UI labels (see app BookingPageCopy).
booking_page_copy_presetStringenglish or spanish presets in the UI.

Media and layout

KeyTypeDescription
logo_urlStringLogo image URL.
cover_image_urlStringHero cover image URL.
video_urlStringIntro video shown on the page (YouTube, Vimeo, Loom, Wistia, Google Drive, <iframe> embed code, direct video URL…). Unsupported links return 400.
video_titleStringTitle above the video, trimmed to 200 characters.
booking_logo_placementStringe.g. below_cover.
booking_logo_shapeStringe.g. rounded.
booking_logo_sizeStringe.g. md.
booking_logo_background_colorString
booking_logo_border_colorString
booking_logo_border_width_pxNumber
booking_logo_show_shadowBoolean
booking_logo_show_ringBoolean
booking_logo_ring_colorString
booking_logo_ring_width_pxNumber

Theme and colors

KeyTypeDescription
booking_page_themeStringcustom or preset mode from theme picker.
primary_colorString
background_colorString
text_colorString
heading_colorString
muted_text_colorString
link_colorString
on_primary_colorString
surface_colorString
surface_border_colorString
input_background_colorString
input_border_colorString
hero_title_text_colorString
hero_subtitle_text_colorString
service_icon_text_colorString
summary_banner_colorString
instruction_banner_colorString
instruction_banner_text_colorString
empty_state_background_colorString
empty_state_border_colorString
empty_state_text_colorString
slot_button_background_colorString
slot_button_idle_text_colorString
stepper_inactive_colorString
stepper_connector_colorString
stepper_text_colorString
service_list_background_colorString
service_list_border_colorString
service_list_heading_text_colorString
service_list_primary_text_colorString
service_list_secondary_text_colorString
calendar_panel_background_colorString
calendar_panel_border_colorString
calendar_section_heading_text_colorString
calendar_panel_text_colorString
times_panel_background_colorString
times_panel_border_colorString
times_section_heading_text_colorString
times_panel_secondary_text_colorString
times_panel_text_colorString
details_section_heading_text_colorString
customer_details_text_colorString
confirmation_title_text_colorString
confirmation_body_text_colorString
confirmation_recap_text_colorString
policy_footer_text_colorString
summary_strip_primary_text_colorString
summary_strip_secondary_text_colorString

Service list presentation

KeyTypeDescription
service_list_thumbnail_modeStringcolor, image, letter, or none.
service_list_layoutStringlist or grid.
show_service_descriptionBooleanDefault true if omitted.
show_powered_byBoolean

Contact form

KeyTypeDescription
booking_contact_fieldsObjectFlags for first_name, last_name, email, phone, party_size, notes.
booking_contact_identify_modeStringemail_first or phone_first.
booking_identify_show_headingBoolean
booking_identify_show_helperBoolean
booking_default_phone_country_isoStringe.g. US.
booking_default_phone_country_codeStringe.g. +1.
booking_default_party_sizeNumber
booking_contact_custom_field_idsNumber[]Contact custom field IDs to show.
booking_reservation_custom_field_idsNumber[]Reservation custom field IDs to show.

Service selection (mode-dependent)

KeyTypeDescription
booking_service_idsNumber[]Services shown with selected_services when no sections are set.
booking_service_sectionsArray{ id, title, service_ids: number[] } groups for selected_services. When present, takes precedence over booking_service_ids.
booking_all_services_orderNumber[]Optional order for all_services.
booking_all_services_sectionsArraySame section shape for all-services mode.

Upload a logo, cover or video file with

POST
/s3-url-signing (types booking-link-logo, booking-link-cover, meeting-booking-video),
PUT
the
file to the signed URL, then store the URL in page_config.

Related

Report an issue with this documentation

Please log in to report issues with our documentation.