Skip to main content
PUT
Error

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Path Parameters

id
string
required
Minimum string length: 1

Body

application/json
name
string
Minimum string length: 1
email
string<email> | null
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
phone
string | null
Minimum string length: 1
postalCode
string | null
Minimum string length: 1
addressLine
string | null
Minimum string length: 1
optIn
boolean

Response

The updated customer record. Note the phone key is ABSENT: the request example's phone: null cleared the stored number.

The updated customer record. Note the phone key is ABSENT: the request example's phone: null cleared the stored number.

id
string
required
Minimum string length: 1
name
string
required
Minimum string length: 1
tier
string
required
Minimum string length: 1
points
integer
default:0
required
Required range: 0 <= x <= 9007199254740991
spend
number
default:0
required
Required range: x >= 0
orders
integer
default:0
required
Required range: 0 <= x <= 9007199254740991
optIn
boolean
default:false
required
email
string<email>
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
phone
string
postalCode
string
addressLine
string