Create block

Create a new block.

Authorization

authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

Block params

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for creating a block.

all_day?boolean

Whether the block is all day.

attachment_type*string

The type of attachment for the block.

Value in

"location"
"service"
"provider"
"service_provider"

attachments?array<string>

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).

date*string

The date of the block.

Formatdate

end_time?|

The end time of the block.

Match^(?:[01]\d|2[0-3]):[0-5]\d$

exception_dates?array<>

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

recurrence_rule?|null

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

service_id?|

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

start_time?|

The start time of the block.

Match^(?:[01]\d|2[0-3]):[0-5]\d$

time_zone?string

The time zone of the block.

title?string

The title of the block.

Response Body

`application/json`

curl -X POST "https://example.com/v1/blocks" \  -H "Content-Type: application/json" \  -d '{    "all_day": false,    "attachment_type": "provider",    "attachments": [      "prov_d025a96ac0c6"    ],    "date": "2025-10-27",    "end_time": "17:00",    "exception_dates": [      "2025-10-27T09:00:00"    ],    "recurrence_rule": {      "byday": [        "mo",        "we",        "fr"      ],      "freq": "weekly"    },    "start_time": "09:00",    "time_zone": "America/New_York",    "title": "Initial Consult"  }'

{  "data": {    "all_day": false,    "attachment_type": "provider",    "attachments": [      "prov_d025a96ac0c6"    ],    "created_at": "2017-09-12T12:34:55Z",    "date": "2025-10-27",    "end_time": "17:00",    "exception_dates": [      "2025-10-27T09:00:00"    ],    "id": "blk_d025a96ac0c6",    "object": "block",    "recurrence_rule": {      "byday": [        "mo",        "we",        "fr"      ],      "freq": "weekly"    },    "service_id": null,    "start_time": "09:00",    "time_zone": "America/New_York",    "title": "Team Meeting",    "updated_at": "2017-09-13T10:11:12Z"  }}

Authorization

Request Body

Response Body

201application/json

401application/json

422application/json

`application/json`

`application/json`

`application/json`