Skip to main content
POST
Create a schedule 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

Schedule 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-01-05"

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-12-31"

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,WE"

weeklyTimeRanges
object[]
required

The working ranges per weekday; at least one.

Minimum array length: 1
Example:
appliesToAllOfferings
boolean
required

True = every ACTIVE offering of the supplier’s services; false = exactly serviceOfferingIds.

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:
serviceOfferingIds
string[]

The offerings this schedule serves when appliesToAllOfferings is false; must be ACTIVE offerings of services the supplier provides.

Example:
locationRefs
object[]

Where the supplier works under this schedule. A schedule needs locations, a travel zone, or both.

Example:
travelZoneRef
object

The area the supplier travels to under this schedule, if any.

Example:
startLocation
object | null

Where the supplier starts each working day under this schedule, if set. Send null to remove it.

Example:
endLocation
object | null

Where the supplier ends each working day under this schedule, if set. Send null to remove it.

Example:
driveTiming
enum<string> | null

Whether the drive to the first and from the last booking counts inside or outside working hours. Null uses the project default.

Available options:
INSIDE_HOURS,
OUTSIDE_HOURS,
null
Example:

"OUTSIDE_HOURS"

maxTravelOnStartDrive
boolean | null

Whether the start drive is limited by the supplier’s maximum travel time. Null uses the project default.

Example:

true

maxTravelOnEndDrive
boolean | null

Whether the end drive is limited by the supplier’s maximum travel time. Null uses the project default.

Example:

true

Response

Schedule created

data
object
required