Skip to main content
POST
Create a blocked time for the signed-in supplier

Authorizations

x-api-key
string
header
required

API key minted in the MarketBox dashboard. Scope is restricted to the projects you select at creation time. Every route needs the key's standard API access (*) except POST /v1/projects/{projectId}/events, which needs events:write; a key without * is refused with 403 CAPABILITY_NOT_GRANTED.

Authorization
string
header
required

The signed-in person's Cognito access token, issued to this application's app client. Sent with the API key on the /clients/me and /suppliers/me routes.

Path Parameters

projectId
string
required

The project (tenant) that owns the resource. Every resource in this API is scoped to a project, and your API key is restricted to the projects it was issued for — a project outside that scope returns 403.

Minimum string length: 1
Example:

"prj_01kv60qgnef2kt3pvqgwmkbzfr"

Body

application/json

Blocked time data

startDate
string
required

First calendar day the row applies to, YYYY-MM-DD in its zone.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-07-01"

endDate
string
required

Last calendar day the row applies to (inclusive), YYYY-MM-DD; on or after startDate.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-07-14"

rrule
string
required

The recurrence (RFC 5545 RRULE, weekly), expanded per occurrence in the row’s zone.

Minimum string length: 1
Example:

"FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR"

allDay
boolean
required

True blocks the whole of each day; false blocks only timeRanges.

Example:

true

status
enum<string>
default:ACTIVE

ACTIVE rows are offered for booking; INACTIVE rows are kept but offer nothing.

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

timezone
string

IANA zone the wall-clock times are in. Omit to use the supplier’s profile zone, then the project default (R-11); never UTC by accident.

Minimum string length: 1
Example:

"America/Toronto"

exdates
string[]

Calendar days (YYYY-MM-DD) skipped from the recurrence.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:
timeRanges
object[]

The blocked ranges when allDay is false; at least one.

Example:
notes
string

A free-text note about the block, for the supplier and staff.

Example:

"Holiday"

Response

Blocked time created

data
object
required