Cancel Appointment

Collect Appointment Info

Cancels the user's previously booked appointment. Upon booking their original appointment, the client (user) will receive a cancel link via email.

info

The "callback" property allows a custom callback function to be run after the appointment has been submitted. This callback function must be appended to the window with the same name provided in the settings file. This callback function will pass the appointment information to your custom function. See Example

settings.json

{
  "cancel_step": {
    "title": "Cancel appointment",
    "type": "booking",
    "model": "cancel-appointment",
    "callback": "processAppointment"
  }
}

Schema Overview

model required	string Value: "cancel-appointment"
type required	string Value: "booking"
button_text	string The text on the button in the cancel flow
reason_label	string The label describing the input field that allows the user to leave a reason as to why they are canceling their appointment.
reason_placeholder	string Placeholder text in the cancellation reason input text box.
success_message	string The message that is displayed to the user after they've successfully canceled their appointment.
callback	string
dialogue_title	string The dialogue title is the instructions or question text content for a given step.
dialogue_instructions	string
disable_images	boolean Hides images from appointment related lists of options that are pulled from the Setster API automatically.
title	string The title of the step which is the first text content on the top of the step view. The title should describe the current step in a short and concise way.
can_skip	boolean When set to false the step is required to be answered before moving on to the next step. When set to true the user can skip answering the step.
class	string Adds a custom CSS class name to the step to allow for easy CSS selection and modifications at the step level.
layout	string (AppState.ILayout) Enum: "cards" "list" There are two available layouts for single select steps; cards and list. The cards layout consists of selectable retangular cards that are displayed in a single row grid format. Navigating between card options is handled by a horizontal carousel. Cards contain text and/or images. The list layout is a list of selectable items with a vertical scroll. List items may also contain text and/or images. The list layout is better suited for smaller images such as icons while the cards layout is better suited to larger images.

{

• "cancel_step": {

  • "title": "Cancel appointment",
  • "type": "booking",
  • "model": "cancel-appointment",
  • "callback": "processAppointment"

  }

}

Full Schema

Loading ....

Example

model required	string Value: "cancel-appointment"
type required	string Value: "booking"
button_text	string The text on the button in the cancel flow
reason_label	string The label describing the input field that allows the user to leave a reason as to why they are canceling their appointment.
reason_placeholder	string Placeholder text in the cancellation reason input text box.
success_message	string The message that is displayed to the user after they've successfully canceled their appointment.
callback	string
dialogue_title	string The dialogue title is the instructions or question text content for a given step.
dialogue_instructions	string
disable_images	boolean Hides images from appointment related lists of options that are pulled from the Setster API automatically.
title	string The title of the step which is the first text content on the top of the step view. The title should describe the current step in a short and concise way.
can_skip	boolean When set to false the step is required to be answered before moving on to the next step. When set to true the user can skip answering the step.
class	string Adds a custom CSS class name to the step to allow for easy CSS selection and modifications at the step level.
layout	string (AppState.ILayout) Enum: "cards" "list" There are two available layouts for single select steps; cards and list. The cards layout consists of selectable retangular cards that are displayed in a single row grid format. Navigating between card options is handled by a horizontal carousel. Cards contain text and/or images. The list layout is a list of selectable items with a vertical scroll. List items may also contain text and/or images. The list layout is better suited for smaller images such as icons while the cards layout is better suited to larger images.

{

• "cancel_step": {

  • "title": "Cancel appointment",
  • "type": "booking",
  • "model": "cancel-appointment",
  • "callback": "processAppointment"

  }

}

Related API Endpoint

Setster Studio handles all of the Setster API configurations in the background. For more advanced functionality, see the API.

• Cancel Endpoint