Update a loyalty customer
Update loyalty service customer by external ID.
-
Hey Pongo:
- phone is required
-
Como:
- at least phone or email is required
-
Little Bill:
- this method is not supported
Those settings can be found in the Third-Party settings in
POS APIvia/v2/third-party/.
PATCH
/v1/customers/{id}authorization<token>
To get an API key, please contact us. We'll be happy to help you.
In: header
Path Parameters
idstring
Customer id
Format
uuidemail?string|null
phoneNumber?string|null
firstName?string|null
lastName?string|null
creditLimit?integer|null
lastActivityAt?unknown
status?string
Default
"active"Value in
"active" | "suspended" | "inactive"birthDate?string|null
hasOptinSms?boolean|null
hasOptinEmail?boolean|null
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:4010/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "firstName": "John", "lastName": "Doe", "email": "john@doe.com", "phoneNumber": "+33601020304", "birthDate": null, "hasOptinSms": true, "hasOptinEmail": null }'{
"id": "c49f95c8-8fd6-4ab5-8a01-e56c8fdd916d",
"firstName": "John",
"lastName": "Doe",
"email": "john@doe.com",
"phoneNumber": "+33601020304",
"birthDate": null,
"hasOptinSms": null,
"hasOptinEmail": null,
"externalLoyaltyId": "external-loyalty-id-12345"
}{
"code": "CUSTOMER_NOT_FOUND",
"message": "No customers found."
}{
"code": "CUSTOMER_UPDATE_BODY_NOT_VALID",
"message": "Customer update body is invalid."
}{
"code": "UNEXPECTED_ERROR",
"message": "Internal server error"
}{
"code": "NOT_IMPLEMENTED",
"message": "This method is not implemented."
}