Update an appointment type

patch

https://api.rehabguru.com/api/v1/appointment-types/{id}

Partially update an appointment type. Only provided fields are changed; omitted fields retain their current values. The existing record is fetched and merged with the request body. Updating an appointment type will re-sync all active appointments of this type to external calendars — this may take longer for types with many active appointments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique appointment type object ID.

Body Params

Request body for partially updating an appointment type. Only provided fields are changed; omitted fields retain their current values. At least one field must be provided.

name

string

Display name.

description

string

Description.

duration

number

≥ 1

Duration in minutes (must be > 0).

gap

number

Buffer time in minutes.

meetingType

string

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

price

number

deposit

number

allowDeposit

boolean

refundableDeposit

boolean

showInPortal

boolean

color

string | null

timeZone

string

isGlobal

boolean

practitioners

array of strings

practitioners

displayAsClass

boolean

displayRemainingSpots

boolean

maxAttendees

number | null

seriesCount

number | null

2 to 30

preferredTemplateId

string | null

emailTemplate

object | null

syncableCalendars

array of objects

syncableCalendars

Responses

200The updated 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.

404The requested resource was not found.

500An unexpected error occurred on the server.