Skip to main content

006-CreateChildProfile

Function​

Create Child Profile

Endpoint​

  • /v1/loyalty/profile/child

HTTP Method​

  • POST

Request Headers​

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

Request Payload​

{
"masterSsoId": "ssoId",
"emailId": "emailId@example.com.cn",
"mobileNo": "88888888",
"dayOfBirth": "01",
"monthOfBirth": "12",
"yearOfBirth": "2023",
"countryCode": "852",
"masterMemberId": "KT00000001",
"firstname": "",
"lastname": "",
"chineseName": ""
}

Request Parameters​

FieldRequiredTypeRemarkSample
masterSsoIdNostringUnique identifier associated with the master user data stored in SSO
emailIdNostringEmail address
mobileNoNostringMobile No. without country code entered by the child88888888
dayOfBirthNostringDD
monthOfBirthYesstringMM
yearOfBirthYesstringYYYY
countryCodeNostring
masterMemberIdNostringmasterMemberId
firstnameYesstring
lastnameYesstring
chineseNameYesstringChinese fullname

Response Payload​

{
"status": 1,
"errorCode": 0,
"message": "success",
"childId": "CHILD00000001",
"masterSsoId": "ssoId",
"emailId": "emailId@example.com.cn",
"mobileNo": "88888888",
"yearOfBirth": "2023",
"monthOfBirth": "12",
"dayOfBirth": "01",
"countryCode": "852",
"masterMemberId": "KT00000001",
"firstname": "",
"lastname": "",
"chineseName": ""
}

Response Parameters​

FieldRequiredTypeRemarkSample
statusYesstringstatus code of the api call
messageYesstringdetail message of the api call
errorCodeNostring
childIdNostring

Rules​

  • masterSsoId / masterMemberId : Required One

Response Headers​

Error Codes​

CodeDescription
1Internal Error
2Child Already Exists
3Missing Parameter
4Invalid Input: [field name]
5Member Not Exists
4100Member not found
4151Child Already Exists