Create an appointment type

post

https://api.rehabguru.com/api/v1/appointment-types

Create a new appointment type. For global types (isGlobal: true), the authenticated user must be a team administrator.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body for creating an appointment type.

name

string

required

Display name.

description

string

required

Description of the appointment type.

duration

number

required

≥ 1

Duration in minutes (must be > 0).

gap

number

required

Buffer time in minutes between appointments.

meetingType

string

required

The platform or format for the appointment. Common values include standard, telehealth_lite, telehealth_pro, class, and class_block.

price

number

required

Price in your currency.

deposit

number

required

Deposit amount.

allowDeposit

boolean

required

Whether deposits are enabled.

refundableDeposit

boolean

required

Whether the deposit is refundable.

showInPortal

boolean

required

Whether this type is visible in the client booking portal.

color

string | null

Hex colour code.

timeZone

string

IANA time zone identifier.

isGlobal

boolean

Defaults to false

Create as a team-wide type (requires team admin).

practitioners

array of strings

User IDs of practitioners assigned to this global type.

practitioners

displayAsClass

boolean

Show as class in portal (class/class_block only).

displayRemainingSpots

boolean

Show remaining spots (class/class_block only).

maxAttendees

number | null

Max participants (class/class_block only).

seriesCount

number | null

2 to 30

Sessions in series, 2–30 (class_block only).

preferredTemplateId

string | null

Form template ID to attach. Not available for class types.

emailTemplate

object | null

Custom email templates.

syncableCalendars

array of objects

External calendar sync settings.

syncableCalendars

Responses

201The newly created appointment type.

400Invalid request — validation failed or missing required fields.

401Authentication failed — missing or invalid API key.

403Authenticated but not allowed to perform this action.

500An unexpected error occurred on the server.