Skip to main content
POST
cURL

Body

application/json
location_id
integer
required
practitioner_id
integer
required
starts_at
string<date-time>
required
ends_at
string<date-time>
required
busy_time_type_id
integer | null
name
string | null
note
string | null
Maximum string length: 255
room_id
integer | null
vehicle_id
integer | null
repeating_rule
object
resource_ids
integer[]

Response

BusyTimeResource

id
string

The busy time's unique identifier.

Example:

"bti_01HQFQ9QWTNNPY58FZ8CB3FWWK"

location_id
string

The location identifier where the busy time takes place.

Example:

"loc_01HQFQ9QWTNNPY58FZ8CB3FWWK"

practitioner_id
string

The practitioner identifier assigned to the busy time.

Example:

"pra_01HQFQ9QWTNNPY58FZ8CB3FWWK"

starts_at
string

The busy time start time (ISO 8601).

Example:

"2024-01-01T10:00:00Z"

ends_at
string

The busy time end time (ISO 8601).

Example:

"2024-01-01T11:00:00Z"

duration
integer

The busy time duration in minutes.

Example:

60

name
string | null

The busy time name.

Example:

"Lunch break"

note
string | null

The busy time note.

Example:

"Practitioner unavailable for personal appointment."

created_at
string

The timestamp when the busy time was created (ISO 8601).

Example:

"2024-01-01T12:00:00Z"