Skip to main content
POST
Bootstrap user

Authorizations

Authorization
string
header
required

Marea API key. mk_dev_* keys are developer-scoped (bootstrap, list users, register webhook). mk_user_* keys are user-scoped (manage that one user's storefronts/products). Scopes: catalog:read, catalog:write, storefront:publish, me:verify, me:resendVerification, developer:bootstrap, developer:read, developer:issueUserKey, developer:webhooks.

Headers

Idempotency-Key
string

Optional client-supplied key. Replays of the same key within 24h return the original response. Recommended for POSTs that mutate billing/inventory.

Maximum string length: 200
Example:

"idem_b2a9f5b9-3e0c-4a5e-b3c2-7a4ce85a6b21"

Accept-Language
string

BCP-47 locale tag for localized error messages (es, en, pt). Defaults to es.

Example:

"es-MX"

Body

application/json

Request body.

email
string<email>
required
displayName
string
required
Required string length: 1 - 200
sourceAgent
string
required
Required string length: 1 - 64
Pattern: ^[A-Za-z0-9 _.-]+$
country
string | null
Pattern: ^[A-Z]{2}$
language
enum<string> | null
Available options:
es,
en,
pt
currency
string | null
Pattern: ^[A-Z]{3}$
businessType
string | null
initialStorefront
object

Agent-facing storefront input shape (RFC §6.18.1). Every field is PATCHable per §6.18.1.1.

Response

Resource created.

userId
string
required
userKey
string
required
Pattern: ^mk_user_
verificationStatus
enum<string>
required
Available options:
pending
verificationExpiresAt
string<date-time>
required
verificationDeliveryHint
enum<string>
required
Available options:
email-only
appliedDefaults
object
required
storefrontId
string | null
idempotent
boolean
errors
object[]