Skip to main content

010-GetUpdatedProfile

Function

GetUpdatedProfile

Endpoint

  • /v1/loyalty/profile/updated

HTTP Method

  • GET

Request Headers

  • Authorization: Bearer {token}
  • X-App-Key: {appKey}

Query Param

FieldRequiredTypeRemarkSample
lastUpdateDateYstringlast update date2024-02-28
limitNnumberlimit, default 100, maxium 1000100
offsetNnumberoffset, default 00

Response Payload

{
"status": 1,
"errorCode": 0,
"message": "success",
"members": [
{
"memberId": "XXX",
"email": "john@example.com",
"firstname": "John",
"lastname": "Chen",
"chineseName": "XXX",
"nickname": "XXX",
"languagePreference": "zh_HK",
"countryCode": "852",
"mobileNo": "910383932",
"memberStatus": "Inactive",
"ssoId": "XXX"
}
],
"totalRecords": 10
}

Response

FieldRequiredTypeRemarkSample
statusYesnumberstatus code of the api call, 1=success, 0=fail
messageYesstringdetail message of the api call
errorCodeNonumber
membersNoarray
members.memberIdNostring
members.emailNostring
members.firstnameNostring
members.lastnameNostring
members.chineseNameNostring
members.nicknameNostring
members.languagePreferenceNostring
members.countryCodeNostring
members.mobileNoNostring
members.memberStatusNostringmemberStatus: Active、Inactive
members.ssoIdNostring
totalRecordsNonumbertotal records10

Error Codes

Status CodeStatus Description
1Internal Error
2Member does not Exist
3Missing Parameter
4Invalid Input: [field name]
4100Member not found