Back to All

API Change Log - November 08, 2023

6 months ago by Jishnu Ramakrishnan

Updates for this release.

Appointment

  • API Endpoint: {api_url}/v1/categories/appointments

  • Scenario: While organizing and managing different types of appointments, it is helpful if the user knows where an appointment category is created. You can use this API to get the the center ID where the appointment category is created.

  • Earlier behavior: No request parameter related to center ID and no response parameter releated to where an appointment category is created.

  • New behavior: The API now has a new response parameter owned_by_context_type and a new request parameter, center_id.

  • API documentation link: 

Payouts

  • API Endpoint: {api_url}/v2/centers/{center_id}/waitlist

  • Scenario: Prefunding calculations are used to determine the amount of funds that need to be maintained in an intermediary checking account for the purpose of payouts, such as tips. This API fetches the names of employees for single and multiple centers for tips prefunding calculations.

  • Earlier behavior: NA

  • New behavior: This API fetches employees for single and multiple centers for tips prefunding calculations.

  • API documentation link: 

  • API Endpoint: {api_url}/v1/payouts/employees?onboarding_type=Tips

  • Scenario: Prefunding calculations are used to determine the amount of funds that need to be maintained in an intermediary checking account for the purpose of payouts, such as tips. This API saves the names of employees for multiple centers for tips prefunding calculations.

  • Earlier behavior: NA

  • New behavior: This API saves therapist info for multiple centers for prefunding calculations.

  • API documentation link: 

Memberships

  • API Endpoint: {api_url}/v1/guests/{GuestId}/memberships/{UserMembershipId}/waive

  • Scenario: Using the Save Waive Membership API, now you can save waive cancel reasons in ZMA. Waive reasons are used when waiving a membership payment. Your front-desk staff member has to select the reason for the waiver.

  • Earlier behavior: NA

  • New behavior: Now you can save waive membership cancel reasons in ZMA.

  • API documentation link: 

  • API Endpoint: {{api_url}}/v1/organizations/settings/{section}

  • Scenario: Waive reasons are used when waiving a membership payment. Your front-desk staff member has to select the reason for the waiver. This API now includes more waive cancel reasons.

  • Earlier behavior: NA

  • New behavior: A new list of waive reasons added in the membership object.

  • API documentation link: 

Employee

  • API Endpoint: {api_url}/v1/blockouttimes/types?view_id={view_id}&view_type={view_type}&view_filter={view_filter}

  • Scenario: To gain finer control over how you retrieve block-out time data, use this API to specify the preferred view (zone, center, or organization).

  • Earlier behavior: The following parameters did not exist:

view_id : the unique identifier of the view from which the block out times need to be retrieved

view_type : 1-Zone,2-Center,0-Organization

view_filter: 0- all blockouttimes 1-associated in any center

  • New behavior: The following parameters are now added:

view_id : the unique identifier of the view from which the block out times need to be retrieved

view_type : 1-Zone,2-Center,0-Organization

view_filter: 0- all blockouttimes 1-associated in any center

Campaigns

  • API Endpoint: {api_url} /v1/campaigns/save_automated_campaign

  • Scenario: A marketing manager can, instead of manually creating a new campaign in Zenoti, use this API to save an automated campaign from a pre-existing template.

  • Earlier behavior: NA

  • New behavior: This API can be used to save and schedule an express campaign.

  • API documentation link: