Newer Version Available

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

Member Profile

Get the details of a loyalty program member.

For community users, the Get Member Profile API supports context-based resolution. When membershipNumber isn’t provided, the API automatically returns the profile of the logged-in member.

Note

Resource
1/loyalty-programs/${loyaltyProgramName}/members
Examples
1https://yourInstance.salesforce.com/services/data/v66.0/loyalty-programs/${baLoyalty}/members
1https://yourInstance.salesforce.com/services/data/v66.0/loyalty-programs/${baLoyalty}/members?memberId=007
1https://yourInstance.salesforce.com/services/data/v66.0/loyalty-programs/${baLoyalty}/members?membershipNumber=doc_member1
1https://yourInstance.salesforce.com/services/data/v66.0/loyalty-programs/${baLoyalty}/members?programCurrencyName=Yen
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. Required

This field is optional if you provide the membership number.

Note

55.0
membershipNumber String The membership number of the loyalty program member.

If this value is omitted or empty, and the request is made by a logged-in community user, the API returns the member profile associated with the current user context.

Required

This field is optional if you provide the member ID.

Note

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