CreateBlockRequest

Request schema for creating a block.

all_dayboolean

Whether the block is all day.

attachment_typestringrequired

The type of attachment for the block.

Possible values: [location, service, provider, service_provider]

attachmentsstring[]

The resources to which this block is attached. These can be service IDs (to block availabilty for all providers on a service), provider IDs (to block availability for a specific provider), service provider IDs (to block availability for a specific service provider), or location IDs (to block availability for a specific location).

end_datestring<date>required

The end date of the block.

end_timestringnullable

The end time of the block.

Possible values: Value must match regular expression ^(?:[01]\d|2[0-3]):[0-5]\d$

exception_datesstring[]

Exceptions for recurring block instances (in naive date time format).

Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

recurrence_rule objectnullable

The recurrence rule for the block (or null if there is no recurrence).

bydaystring[]

The days of the week on which the recurrence occurs.

Possible values: Value must match regular expression (mo|tu|we|th|fr|sa|su)$

Example: ["mo","we","fr"]

countintegernullable

Number of occurrences at which to end the recurrence.

Possible values: >= 1

freqstringrequired

The frequency of the recurrence.

Possible values: [daily, weekly]

intervalinteger

How often the recurrence rule repeats.

Possible values: >= 1

Example: 2

untildatenullable

Date at which to end the recurrence (in ISO-8601 format).

Example: 2024-01-02

service_idstringnullable

The ID of the service for the block. Required when attachment_type is service_provider.

start_datestring<date>required

The start date of the block.

start_timestringnullable

The start time of the block.

Possible values: Value must match regular expression ^(?:[01]\d|2[0-3]):[0-5]\d$

time_zonestring

The time zone of the block.

titlestring

The title of the block.

CreateBlockRequest

{
  "all_day": false,
  "attachment_type": "provider",
  "attachments": [
    "prov_d025a96ac0c6"
  ],
  "end_date": "2025-10-27",
  "end_time": "17:00",
  "exception_dates": [
    "2025-10-27T09:00:00"
  ],
  "recurrence_rule": {
    "byday": [
      "mo",
      "we",
      "fr"
    ],
    "freq": "weekly"
  },
  "start_date": "2025-10-27",
  "start_time": "09:00",
  "time_zone": "America/New_York",
  "title": "Initial Consult"
}