Skip to main content
PATCH
Update the signed-in supplier’s own profile

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

The fields to change

firstName
string

The supplier’s first name. Omit to leave it unchanged.

Minimum string length: 1
Example:

"Ada"

lastName
string

The supplier’s last name. Omit to leave it unchanged.

Minimum string length: 1
Example:

"Lovelace"

phone
string | null

Phone number, stored in E.164 form. Omit to leave it unchanged; pass null or an empty string to clear it.

Example:

"+14165550134"

addressoneline
string

The full address on one line. Omit to leave it unchanged.

Example:

"120 Front St W, Toronto, ON M5J 2M2"

street
string

Street address. Omit to leave it unchanged.

Example:

"120 Front St W"

city
string

City. Omit to leave it unchanged.

Example:

"Toronto"

state
string

State or province, e.g. an ISO 3166-2 subdivision. Omit to leave it unchanged.

Example:

"CA-ON"

country
string

Country, e.g. an ISO 3166-1 alpha-2 code. Omit to leave it unchanged.

Example:

"CA"

postalcode
string

Postal or ZIP code. Omit to leave it unchanged.

Example:

"M5J 2M2"

longitude
number

Longitude of the supplier’s address. Omit to leave it unchanged.

Example:

-79.3832

latitude
number

Latitude of the supplier’s address. Omit to leave it unchanged.

Example:

43.6532

timezone
string

IANA time zone the supplier works in; their daily agenda email fires at 07:00 in it, and changing it moves that schedule. Omit to leave it unchanged.

Example:

"America/Toronto"

bio
string | null

A short biography. Omit to leave it unchanged; pass null to clear it.

Example:

"Certified swim instructor with ten years of experience."

serviceIds
string[]

The complete set of service ids the supplier offers: it replaces the current set. Omit to leave the services unchanged.

Example:
skillIds
string[]

The complete set of skill ids the supplier holds: it replaces the current set. Omit to leave the skills unchanged.

Example:
languages
enum<string>[]

The languages the supplier speaks (ISO 639-1 codes): replaces the current list. Omit to leave it unchanged.

Available options:
en,
fr,
es,
de,
it,
pt,
nl,
zh,
ja,
ko,
ar,
hi,
ru,
pl,
tr,
vi
Example:

Response

The updated supplier

data
object
required