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

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

Supplier data

firstName
string
required
Minimum string length: 1
lastName
string
required
Minimum string length: 1
email
string<email>
required
phone
string | null

Phone number. Accepts E.164 or a national NANP number; stored as E.164 (e.g. +14165550134).

addressoneline
string
street
string
city
string
state
string
country
string
postalcode
string
longitude
number
latitude
number
timezone
string

IANA timezone the supplier works in. Drives when their daily agenda email fires: it is used verbatim as the EventBridge schedule timezone, so a value the scheduler rejects means no agenda email at all. Unset inherits the project’s defaultTimezone.

Example:

"America/Toronto"

bio
string
maxTravelTime
integer
Required range: x >= 0
externalId
string
externalData
object
active
boolean
default:true
serviceIds
string[]
skillIds
string[]
languages
enum<string>[]
Available options:
en,
fr,
es,
de,
it,
pt,
nl,
zh,
ja,
ko,
ar,
hi,
ru,
pl,
tr,
vi
defaultLocale
string

The supplier's own preferred locale (BCP-47, e.g. 'fr-CA'). Staff-set only — never inferred from a booking. Omit to inherit the project default.

Example:

"fr-CA"

Response

Supplier created

data
object
required