API Change Log – 07 Jan 2025

Updates for this release

Booking Wizard

API Endpoint: {api_url}/v1/appointments/alternatives/list
Scenario: This API addresses the 2000-character URL limit encountered by the GET v1/appointments/alternatives API when handling more than 51 appointment IDs. A new POST API replaces it, retaining the same functionality and request structure, with an added {} wrapper in the response object.
API method: POST
Earlier behavior: New API. No earlier behavior.
New behavior: This API resolves the limitations of the GET v1/appointments/alternatives API, which fails for URLs exceeding 2000 characters (e.g., with more than 51 appointment IDs). The new POST API offers identical functionality and request parameters, introducing an additional {} wrapper in the response for consistency.

API Endpoint: v1/appointments/{appointment_id}/progress
Scenario: This API marks the progress of an appointment with statuses: open, started, or completed.
API method: PUT
Earlier behavior: New API. No earlier behavior.
New behavior: This API introduces a v1 endpoint to update the status of an appointment.

API Endpoint: {api_url} /v1/growth_features
Scenario: This API retrieves data on Growth features, both adopted and unadopted, to analyze trends and highlight potential value. It efficiently queries the database via stored procedures and provides structured responses for seamless analytics integration.
API method: GET
Earlier behaviorNew API. No earlier behavior.
New behavior: This API provides data on adopted and unadopted Growth features, enabling trend analysis and value visualization. It ensures efficient data retrieval through stored procedures and delivers structured output for client-side analytics.

API Endpoint: {api_url}/v1/guests/guestpass_lifetime_limit?email_id={guest_email_id}&phone_number=&first_name=&last_name=&user_name=
Scenario: This API validates whether a guest has reached their lifetime limit of guest passes.
API method: GET
Earlier behavior: New API. No earlier behavior.
New behavior: This API checks if a guest has exceeded the lifetime allowance for guest passes.

API Endpoint: v1/appointments/{appointment_id}/forms
Scenario: This API adds three parameters (appointment_group_id, form_id, and expand) for filtering data and three properties (is_review_needed, has_custom_script, and is_locked) in the response model.
API method: GET
Earlier behavior: Parameters (appointment_group_id, form_id, and expand) for filtering data and three properties (is_review_needed, has_custom_script, and is_locked) in the response model were not there in this API previously.
New behavior: This API introduces three new parameters (appointment_group_id, form_id, and expand) for data filtering and three new response properties (is_review_needed, has_custom_script, and is_locked).