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
| Field | Type | Required | Description |
|---|---|---|---|
organization_id | integer | Yes | Your organization ID (the API key's organization). |
name | string | Yes | Internal name. |
mode | string | Yes | all_services, single_service or selected_services. |
service_id | integer | When mode is single_service | The service to book. Must belong to your organization. |
slug | string | No | URL segment, unique per organization. Generated from name when omitted. |
is_active | boolean | No | Default true. |
page_config | object | When mode is selected_services | Must contain booking_service_ids or booking_service_sections in that mode. See the page_config reference. |
settings | object | No | Free-form object. Default {}. |
tracking_config | object | No | meta_pixel_id, ga4_measurement_id. |
Request
Response
Returns the created booking link object.
json
Errors
| Status | When |
|---|---|
400 Bad Request | Missing 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 Forbidden | organization_id is not the API key's organization. |
Report an issue with this documentation
Please log in to report issues with our documentation.