Update the buyer's profile

Changes the buyer's name, first and last name, email or phone (send only what changes, with expectedVersion from account.get). Nothing else on the account is writable here; terms and limits belong to the store.

Who may call it: A signed-in buyer (X-Storefront-Buyer); without one the answer is 401 UNAUTHORIZED.

Body Params
string
required
^[a-f0-9]{64}$

Opaque account version returned by account.get.

string
length between 1 and 1000
string
length ≤ 255
string
length ≤ 255
string
length ≤ 255
^\s*(?:[^\s@]+@[^\s@]+\.[^\s@]+)?\s*$
string
length ≤ 255
Headers
string
required
length between 1 and 253

The published storefront host the request serves (shop.example.com, lower case). It must belong to the tenant of the API key; 404 NOT_FOUND when no published storefront answers it, 403 FORBIDDEN when it belongs to another account.

string

The signed-in buyer's access token (accessToken from POST https://apis.kentro.live/auth/login/customer). Absent for a guest or an anonymous visitor.

string

The guest token session.guest answered, which identifies a guest cart and a guest checkout. Send it along with X-Storefront-Buyer at sign-in so the buyer can choose between the guest cart and the account cart.

string

The end buyer's IP address as your storefront server saw it. Used for per-visitor limits (search typeahead, sign-up); without it the limits apply to your server.

string

The store id (store.get answers id) your page was rendered for. When the host now resolves to another store the answer is 409 CONFLICT, so a stale page never acts on the wrong store.

string

The identity your page was rendered for: the buyer id, guest:<guestId> for a guest, or guest for an anonymous visitor. A mismatch with the tokens sent is 409 CONFLICT, so a stale page never acts for the wrong buyer.

Responses

version.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json