Create a schedule block

Create a new schedule block to block off time on a provider's calendar. This prevents appointments from being scheduled during the specified time period. Use this to block time for lunch breaks, meetings, administrative tasks, PTO, or other activities.

Request body

descriptionstring

Description or reason for the schedule block (e.g., "Lunch Break", "Staff Meeting", "PTO")

officeinteger required

ID of the office where the schedule block is applied

colorstring

Custom color associated with the schedule block for calendar display

practice_groupinteger

ID of the practice group for the associated provider (doctor)

start_timestring date-time required

Start time of the schedule block in ISO 8601 format

exam_roominteger

ID of the exam room where the schedule block is applied

seriesinteger

Series ID if the schedule block is part of a recurring series

end_timestring date-time required

End time of the schedule block in ISO 8601 format

providerinteger required

ID of the provider or doctor who owns this schedule block

idinteger

Unique identifier for the schedule block

appointment_breakinteger

ID of an associated appointment break, if applicable

Example request

{
  "description": "Lunch Break",
  "office": 200,
  "color": "#FF5733",
  "practice_group": 1,
  "start_time": "2024-03-15T12:00:00",
  "exam_room": 1,
  "series": null,
  "end_time": "2024-03-15T13:00:00",
  "provider": 100,
  "id": 12345,
  "appointment_break": null
}

Response

Created