Skip to main content
POST
Generate clustered time slots from suppliers + engine config

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.

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

Suppliers + engine config

config
object
required
suppliers
object[]
required

Response

Suggested slots + metrics/kpis

searchId
string
required

The id of this search, also returned as the X-MB-Search-Id header. Every page of a paginated search carries the same id (the cursor keeps it). Keep it for the session if you want attribution: pass it back as searchId when the client books, and in the search.rendered event when you report what you showed.

Example:

"srch_01k7q3x9h4e8rb2d6m0z5a7c1n"

status
string
required
timeSlots
null[]
required

Clustered suggested slots. Each entry carries timeSlotDateAndTime (the slot instant rendered in the response timezone, with that zone's offset at that instant — R-30) and timeSlotStartUtc (the same instant in UTC, Z — R-31, always present, always the same instant as timeSlotDateAndTime). Prefer timeSlotStartUtc as the booking anchor.

errors
string[]
required
metrics
unknown
kpis
unknown