/v1/appointment/book/finish

Overview

GET /v1/appointment/book/finish finalizes an appointment booking after the user has completed the booking flow. It confirms the appointment, triggers configured notifications, and returns a brief summary payload.

Request Details

Method: GET

Path: /v1/appointment/book/finish

Base URL (UAT): https://uat-api.wellnessliving.io

Purpose in flow: This endpoint should be called at the end of the booking process, after the region, business, client, service, staff, time, and any required assets/products have already been selected and validated via preceding /v1/appointment/book/... endpoints.

Query Parameters

id_region (required) – Numeric region identifier (e.g., 2). Determines the geographic/tenant context for the booking.

k_business (required) – Business key for the WellnessLiving business (e.g., 49197). The appointment is finalized under this business.

uid (required) – User/client identifier associated with the booking (e.g., 2720946). This ties the finalized appointment and notifications to the correct client profile.

Authentication

Typically requires an authenticated context (e.g., a valid auth token passed in headers such as Authorization: Bearer {{TOKEN}} or equivalent auth mechanism configured at the collection/folder level).

The request itself does not add additional auth-specific query parameters; it relies on the existing authenticated session/headers used throughout the booking flow.

Response Summary (200 OK)

A successful response returns JSON with at least the following fields:

status – Overall result indicator. For a successful finish call, this is "ok".

s_version – Internal version or build identifier for the API/application (e.g., "444085").

k_location – Location key where the appointment is booked ("0" or a specific location ID).

a_notification – Object describing which notification channels are enabled for this booking confirmation:

is_mail – "1" or "0" indicating whether email notification is sent.

is_push – "1" or "0" indicating whether push notification is sent.

is_sms – "1" or "0" indicating whether SMS notification is sent.

__a_message – Array of internal message/template fragments related to the confirmation (e.g., subject/body pieces, unsubscribe/footer tokens, virtual button metadata). These are primarily for internal rendering and may contain truncated or system-only values.

On success, use status, a_notification, and k_location to verify that the appointment was finalized and to confirm which client notification channels were triggered.

Overview#

Request Details#

Query Parameters#

Authentication#

Response Summary (200 OK)#

Request

Responses

Overview

Request Details

Query Parameters

Authentication

Response Summary (200 OK)