Insert Guests' Feedback into Zenoti

This API inserts a guest's feedback (which has been collected by using a third-party software) on a specific appointment into Zenoti.

For example, an organization uses a third-party software to collect guests' feedback on their appointments. You can then use this API to insert the collected guest feedback from that third-party software into Zenoti.

You must specify appropriate data for the appointment_group_id parameter.

Request Details

NameTypeDescription
commentsstringFeedback comments provided by the guest for the specific appointment.
ratingintegerStar-rating given by the guest for the appointment. The limit of the rating (whether 5 or 10) depends on the feedback setting of the organization (Admin > Organization > Organizations > Settings > Feedback).
apply_for_group_invoicebooleanIf true, the guest's same feedback is applied for the complete group or individual appointment. If false, the same feedback is not considered for the entire group or individual appointment.

Response Details

NameTypeDescription
successbooleanIf true, the guest's feedback on the specified appointment is successfully inserted into Zenoti.
MessagestringIndicates that an error has occurred, and the guest's feedback on the specified appointment is not inserted into Zenoti. For more information on the various error messages, the respective error codes, and their description, refer the Error Message Details table below.

Error Message Details

Error MessageError CodeDescription
Invalid appointment group identifier502If the appointment_group_id is not provided.
Appointment group identifier is not found410If an invalid appointment_group_id is specified.
cannot access438If a Zenoti user who does not have the required permissions enters the feedback.
Feedback has already been given for this appointment4020If the feedback has already been provided for the appointment.
Invalid Input data502If the organization uses the older version (v1) of the feedback tool.
Please Enter a Valid Rating502If a valid integer value is not provided as the star-rating.
Ëxception message502If any other type of error occurs.
Language
Authorization
Header
Click Try It! to start a request and see the response here!