Availability Step Model

Collect Appointment Info

In the Setster step availability model, the user selects the date and time they would like to schedule a previously selected service. The user can select a date and time from the calendar based on their selected service, staff, and location availabilities.

settings.json

{
  "calendar_step": {
    "title": "Select meeting time",
    "type": "booking",
    "model": "availability",
    "first_day_of_week": "monday",
    "months_in_past_enabled": false
  }
}

Schema Overview

model required	string Value: "availability"
type required	string Value: "booking"
first_day_of_week	string Enum: "friday" "monday" "saturday" "sunday" "thursday" "tuesday" "wednesday"
months_in_past_enabled	boolean
client_timezone_selection	string Enum: "auto" "off" "on"
time_format	number Enum: 12 24
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.

{

• "title": "Select meeting time",
• "type": "booking",
• "model": "availability",
• "first_day_of_week": "monday",
• "months_in_past_enabled": false

}

Full Schema

Loading ....

Example

model required	string Value: "availability"
type required	string Value: "booking"
first_day_of_week	string Enum: "friday" "monday" "saturday" "sunday" "thursday" "tuesday" "wednesday"
months_in_past_enabled	boolean
client_timezone_selection	string Enum: "auto" "off" "on"
time_format	number Enum: 12 24
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.

{

• "title": "Select meeting time",
• "type": "booking",
• "model": "availability",
• "first_day_of_week": "monday",
• "months_in_past_enabled": false

}

Related API Endpoint

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

• Availability Endpoint.
• Availability Model.