Member Profile

Get the profile details of a loyalty program member, while asynchronously requesting data from the Member Profile API.

ParameterTypeDescriptionRequired or Optional
devModeBooleanIndicates whether the request is run in developer mode (true) or not (false).Optional
memberIdStringIdentifier of the member whose benefits are being retrieved.Required
versionStringVersion of the API. The request body is available in version 55.0 and later.Optional

A ProfileModel instance of type:

Property NameTypeDescription
additionalLoyalty​ProgramMemberFieldsMap<String, Object>The details of the custom fields added in the loyalty program member object.
associatedAccountCodableThe details of the account record that is associated with the loyalty program member.
associatedContactCodableThe details of the contact record that is associated with the loyalty program member.
canReceivePartnerPromotionsBooleanIndicates whether the loyalty program member can receive partner promotions.
canReceivePromotionsBooleanIndicates whether the loyalty program member can receive promotions (true) or not (false).
enrollmentChannelStringThe channel used by the member to enroll in the loyalty program.
enrollmentDateStringThe date on which the member enrolled in the loyalty program.
groupCreatedByMemberStringThe membership number of the loyalty program member who created the group.
groupNameStringThe name of the loyalty program group to which the member belongs.
lastActivityDateStringThe date on which the member performed their last activity.
loyaltyProgram​MemberIdStringThe ID of the loyalty program member.
loyaltyProgramNameStringThe name of the loyalty program.
memberCurrenciesCodableThe currencies associated with the loyalty program member.
memberStatusStringThe status of the loyalty program member.
memberTiersCodableThe tiers associated with the loyalty program member.
memberTypeStringThe type of loyalty program member.
membershipEndDateStringThe date on which the membership ends.
membershipLast​RenewalDateStringThe date on which the loyalty program member last renewed their membership.
membershipNumberStringThe membership number of the loyalty program member.
referredByStringThe membership number of the loyalty program member who referred the member to the loyalty program.
relatedCorporate​MembershipNumberStringThe membership number of the Corporate type loyalty program member associate with the member.
transactionJournal​StatementFrequencyStringThe frequency at which transaction journal statements must be delivered to the member. Possible values are Monthly or Quarterly.
transactionJournal​StatementLastGeneratedDateStringThe date on which the member’s last transaction journal statement was generated.
transactionJournal​StatementMethodStringThe method used to deliver transaction journal statements to the member.