Skip to main content
POST
/
busy_times
/
{busyTime}
cURL
curl --request POST \
  --url https://api.caspen.com/v1/busy_times/{busyTime} \
  --header 'Content-Type: application/json' \
  --data '
{
  "location_id": 123,
  "practitioner_id": 123,
  "busy_time_type_id": 123,
  "starts_at": "2023-11-07T05:31:56Z",
  "ends_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "note": "<string>",
  "room_id": 123,
  "vehicle_id": 123,
  "resource_ids": [
    123
  ]
}
'
{
  "id": "<string>",
  "location_id": "<string>",
  "practitioner_id": "<string>",
  "starts_at": "<string>",
  "ends_at": "<string>",
  "duration": 123,
  "name": "<string>",
  "note": "<string>",
  "created_at": "<string>"
}

Path Parameters

busyTime
string
required

The busy time ID

Body

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

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"