Release Candidate — the API is undergoing final validation before general availability, and minor changes may still occur.
Hellomateo API Documentation
Calendars

Create Calendar Blocked Time

POST
/v1/calendars/{calendar_id}/blocked-times

Creates a manual blocked time. Public partner creates remain source: manual even when external_id is provided; source: external is reserved for provider synchronization. Optional external_id values are partner-owned, trimmed, case-sensitive, immutable synchronization locators that are unique within this organisation. POST is create-only: a duplicate returns a conflict, and after an ambiguous timeout clients should GET /v1/blocked-times/by by external_id before retrying. A recurring master and every exception require distinct external_id values; create the master first, then use its returned Mateo id as the exception series_id.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

calendar_id*string

Unique identifier of the related calendar.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?|

Human-readable name of the resource.

is_all_day?boolean

Whether the resource is all day.

start_at*string

Timestamp for start at.

Formatdate-time
end_at*string

Timestamp for end at.

Formatdate-time
recurrence_rule?|

Recurrence Rule value for this resource.

series_id?|

Unique identifier of the related series.

replaces_occurrence_at?|

Timestamp for replaces occurrence at.

external_id?|

Identifier assigned by an external system.

Response Body

application/json

curl -X POST "https://api.getmateo.com/v1/calendars/497f6eca-6276-4993-bfeb-53cbbbba6f08/blocked-times" \  -H "Content-Type: application/json" \  -d '{    "start_at": "2019-08-24T14:15:22Z",    "end_at": "2019-08-24T14:15:22Z"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "calendar_id": "c828ce68-4c5a-4491-b76a-af3d888d3f97",  "source": "manual",  "name": "string",  "external_id": "string",  "is_all_day": true,  "start_at": "2019-08-24T14:15:22Z",  "end_at": "2019-08-24T14:15:22Z",  "recurrence_rule": "string",  "series_id": "0f6582ac-1e7e-41dc-a63a-24fccd074d0c",  "replaces_occurrence_at": "2019-08-24T14:15:22Z"}