Dismiss my appointment review prompt
Dismiss the review prompt for one of the current customer’s appointments. This operation is idempotent: dismissing an already dismissed prompt returns success. Dismissing does not create a review and does not block leaving a review later from appointment history.
Path Parameters
The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.
Response
Ok. The operation succeeded.
A representation of an appointment.
The given name of the customer.
1 - 55The services for this appointment.
The duration of the appointment. The value is an ISO 8601 duration string.
For example, an appointment lasting 30 minutes would be represented as
PT30M.
The cost of the appointment, excluding any tips, fees or taxes.
^-?(0|[1-9][0-9]*)\.[0-9][0-9]$"456.78"
The barber for this appointment.
The location for this appointment.
The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.
The appointment state. This is derived and immutable.
pending, scheduled, canceled, completed, rejected, expired The payment state of the appointment. This is derived and immutable.
pending, processing, authorized, paid, failed The sum amount of authorized payments for this appointment.
^-?(0|[1-9][0-9]*)\.[0-9][0-9]$"456.78"
The sum amount of captured payments for this appointment.
^-?(0|[1-9][0-9]*)\.[0-9][0-9]$"456.78"
The sum amount of refunded payments for this appointment.
^-?(0|[1-9][0-9]*)\.[0-9][0-9]$"456.78"
The payment source for this appointment. Only platform payments can be authorized through Guile; external payments, such as cash or peer-to-peer payments, cannot.
platform, external Why this appointment is pending. bookingApproval means the customer
is waiting for the barber's decision. cardConfirmation means the
appointment is not awaiting booking approval but still needs card
confirmation. Absent when the appointment is not pending or when an
older server has not classified the pending state.
bookingApproval, cardConfirmation The immutable request lifecycle when this appointment originated as a booking request. Present while the request is pending and after it is resolved so the barber and customer can render the same outcome.
The off-hours fee accepted when the appointment was created. This is
derived and immutable. It is separate from cost. Creating the
appointment does not authorize or capture this fee; Guile settles it
only after the barber confirms the appointment.
^-?(0|[1-9][0-9]*)\.[0-9][0-9]$"456.78"
The opening band accepted when the appointment was created. This is derived and immutable.
regular, beforeHours, afterHours The tip the customer selected at booking time, when one was included. Not charged until capture.
^-?(0|[1-9][0-9]*)\.[0-9][0-9]$"456.78"
The customer's full surname when the authenticated barber may see it.
1 - 55The customer name the authenticated barber may display under the customer's surname visibility preference.
The IANA time zone for the appointment occurrence.
The identifier of the recurring appointment this appointment belongs to, if any. This field is only present for appointments that are part of a recurring series.
If included, the type of cancelation fee incurred. This is derived and immutable.
lateCancelation, noShow If included, the payment-link send state for this appointment.
The customer message saved with the appointment. Visible only to the appointment's barber and customer.
500Immutable references captured from the booked barber's approved public portfolio at booking time. These remain displayable on the appointment if the barber later changes the public portfolio.
3The cancellation decision recorded when the appointment is canceled.
The fee amounts available before a cancellation decision.
The required deposit for this appointment. Percentage deposits exclude tips, taxes, Guile fees, processing fees, and off-hours fees.
The URL of the calendar event artifact for this appointment.
Present only when the authenticated actor is the appointment's
customer and state is scheduled. Pending, confirming, rejected,
expired, and canceled booking requests do not expose a calendar event.
1024Whether the appointment's customer has already submitted a review for this visit. Present for the owning customer; omitted for other audiences.
Whether the appointment's customer dismissed the review prompt for this visit. Present for the owning customer; omitted for other audiences. Dismissing the prompt does not create a review and does not block leaving a review later from appointment history.