Skip to main content

/member/update

Description

This API call is used to update a loyalty member’s profile details, including contact information, communication preferences, and consent attributes.

Purpose

  • To update a member's name, contact info, or birthday
  • To modify communication and GDPR consents
  • To keep the profile data accurate and current

When to Use

  • When the cashier or user edits profile data
  • After registration, to complete or adjust the member profile
  • During loyalty audits or member requests for updates

Request Format

FieldDescriptionTypeMandatory
memberExisting member identifierMemberY
newMemberDataFields to be updated for the member profileMemberY

Method & URL

POST /member/update

Headers

HeaderTypeRequiredDescription
x-api-keystringYesAPI key for authentication
x-source-typestringYesSource type (e.g., POS, Web, Kiosk)
x-source-namestringYesClient or integration source name
x-pos-idstringYesUnique POS terminal identifier
x-branch-idstringYesIdentifier of the branch or location

Request Example

curl --location --request POST 'https://dev-pos-api.fidelizacion.app/v1/member/update' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {{api-key}}' \
--header 'x-source-type: POS' \
--header 'x-source-name: pos_terminal_01' \
--header 'x-pos-id: POS001' \
--header 'x-branch-id: BR001' \
--data-raw '{
"member": {
"phoneNumber": "1234567890"
},
"newMemberData": {
"email": "updated@example.com",
"firstName": "UpdatedName",
"lastName": "UpdatedLast",
"allowedSMS": false,
"allowedEmail": true,
"termsOfUse": true,
"gdpr": true,
"birthday": "1992-05-12"
}
}'

Success Response

{
"status": "success",
"message": "Member updated successfully",
"data": {
"memberId": "mem_001"
}
}

Error Responses

Member Not Found

{
"status": "error",
"error": {
"code": "203",
"message": "Cannot find any member with the given identifier!"
}
}

Invalid Input

{
"status": "error",
"error": {
"code": "1001",
"message": "phoneNumber is not allowed",
"path": "body.phoneNumber"
}
}

Field Reference

FieldTypeDescription
memberobjectObject to identify the existing member
phoneNumberstringMember's current phone number used for lookup
newMemberDataobjectObject containing fields to update
emailstringNew email address
firstNamestringNew first name
lastNamestringNew last name
allowedSMSbooleanConsent to receive SMS
allowedEmailbooleanConsent to receive emails
gdprbooleanMember has accepted GDPR terms
termsOfUsebooleanMember has accepted terms of use
birthdaystringMember birthday in YYYY-MM-DD format