Newer Version Available

This content describes an older version of this product. View Latest

Member Profile

Get the details of a loyalty program member.
Resource
1/loyalty-programs/${loyaltyProgramName}/members
Example
1https://yourInstance.salesforce.com/services/data/vXX.X
2/loyalty-programs/${baLoyalty}/members
Available version
55.0
Requires Chatter
No
HTTP methods
GET
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
memberId String The ID of the loyalty program member. Optional 55.0
membershipNumber String The membership number of the loyalty program member. Required 55.0
programCurrencyName String The name of the loyalty program currency associated with the member.

Use this parameter to get the details of the member’s points-related information for a specific currency.

Optional 55.0
Response body for GET
Member Profile Output
1{
2"ProgramName": "baLoyalty",
3"AssociatedContactDetails": {
4"Id": "003xx0000000003",
5"FirstName": "Abcd",
6"LastName": "Xyz",
7"Email": "abcd@salesforce.com“
8},
9"AssociatedAccountDetails": {
10"Id": "001xx0000000003",
11"Name": "Salesforce"
12},
13"MembershipNumber": "1234",
14"MemberId": "0lMxx0000A000001EAA",
15"MemberStatus": "Active",
16"MemberType": "Individual",
17"GroupName": "Family Group",
18"GroupCreatedByMember": "GM-001",
19"AssociatedCorporateMembershipNumber": "G-001",
20"ReferredBy": "H-001",
21"LastActivityDate": "2022-01-02",
22"StatementLastGeneratedDate": "2022-09-09",
23"StatementFrequency": "Monthly",
24"StatementMethod": "Email",
25"EnrollmentDate": "2022-01-01",
26"EnrollmentChannel": "POS",
27"CanReceivePromotions": "True",
28"CanReceivePartnerPromotion": "True",
29"MembershipEndDate": "2023-01-01",
30"MembershipLastRenewalDate": "2021-01-01",
31"MemberCurrencies": [
32{
33"ProgramCurrency": "NQP",
34"PointsBalance": 500,
35"EscrowPointsBalance": 25
36}
37],
38"MemberTiers": [
39{
40"TierGroupName": "QualifyingGroup",
41"TierName": "Gold",
42"SequenceNumber": "4",
43"EffectiveDate": "2022-01-01",
44"ExpirationDate": "2022-01-10"
45}
46],
47"AdditionalMemberFieldValues": {
48"SecondaryEmail__c": "abcd@salesforce.com“
49},
50"AdditionalMemberCurrencyFieldValues": {
51"ConversionRate__c": "5"
52},
53"AdditionalMemberTierFieldValues": {
54"PreviousTier__c": "Silver"
55  }
56}