Matchai Docs

Add a day off or special hoursComing soon

Adds a one-day exception. Appointments already booked that day are not changed.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
POST
/availability/overrides

Coming soon. Adds a one-day exception. Appointments already booked that day are not changed.

Scopes: calendar:write

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: calendar:write

Header Parameters

Idempotency-Key?string

A unique string (a UUID works). Retrying with the same key within 24 hours returns the first response instead of acting twice. Reusing a key with a different body returns 409 idempotency_key_reused.

Length1 <= length <= 255

Request Body

application/json
  1. body
date*string

The day.

Formatdate
available*boolean

False for a day off.

start?string

Start HH:MM, when available.

Match^([01][0-9]|2[0-3]):[0-5][0-9]$
end?string

End HH:MM, when available.

Match^([01][0-9]|2[0-3]):[0-5][0-9]$
reason?string

Private note.

Lengthlength <= 200

Response Body

The override.

application/json
  1. response

A one-day exception: a day off, or different hours.

id*string

Override id.

Length1 <= length <= 64
date*string

The day.

Formatdate
available*boolean

False for a day off.

start?|

Start HH:MM, when available.

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

End HH:MM, when available.

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

Private note.

Example Request
curl -X POST 'https://api.matchai.co/v1/availability/overrides' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d' \  -H 'Content-Type: application/json' \  -d '{  "date": "2019-08-24",  "available": true}'
Example Response
{  "id": "string",  "date": "2019-08-24",  "available": true,  "start": "string",  "end": "string",  "reason": "string"}