Create a reservation booking link

Creates a public booking page. It is live at /b/{organization_id}/{slug} on the AchieveApex web app as soon as it is created with is_active: true.

Endpoint

POST
/reservation-booking-links

Body

FieldTypeRequiredDescription
organization_idintegerYesYour organization ID (the API key's organization).
namestringYesInternal name.
modestringYesall_services, single_service or selected_services.
service_idintegerWhen mode is single_serviceThe service to book. Must belong to your organization.
slugstringNoURL segment, unique per organization. Generated from name when omitted.
is_activebooleanNoDefault true.
page_configobjectWhen mode is selected_servicesMust contain booking_service_ids or booking_service_sections in that mode. See the page_config reference.
settingsobjectNoFree-form object. Default {}.
tracking_configobjectNometa_pixel_id, ga4_measurement_id.

Request

Response

Returns the created booking link object.

json

Errors

StatusWhen
400 Bad RequestMissing required field; invalid mode; service_id missing for single_service; no services in page_config for selected_services; a service of another organization; invalid or already used slug; unsupported page_config.video_url; invalid tracking ID.
403 Forbiddenorganization_id is not the API key's organization.

Report an issue with this documentation

Please log in to report issues with our documentation.