Skip to main content
POST
Add a service address to the caller's client 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
addressOneLine
string
required

The whole address on one line, as a person would write it.

Minimum string length: 1
Example:

"10 Main St, Toronto, ON M5V 1A1, Canada"

streetNumber
string
required

The street number.

Minimum string length: 1
Example:

"10"

streetName
string
required

The street name.

Minimum string length: 1
Example:

"Main St"

city
string
required

The city or town.

Minimum string length: 1
Example:

"Toronto"

state
string
required

The state, province or region; an ISO 3166-2 code when one matches.

Minimum string length: 1
Example:

"ON"

country
string
required

The country; ISO 3166-1 alpha-2, alpha-3 or the English name.

Minimum string length: 1
Example:

"CA"

zipCode
string
required

The postal or ZIP code, in any national format.

Minimum string length: 1
Example:

"M5V 1A1"

unitNumber
string | null

The unit, suite or apartment, if any.

Example:

"4B"

Response

Address added

data
object
required
address
object
required