Loyalty Management Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Loyalty Management Standard Objects
Loyalty Management Fields on Standard Objects
Coupon Objects in Loyalty Management
Loyalty Management Associated Objects
Apex Reference
Loyalty Management Business APIs
REST Reference
Resources
Request Bodies
Cart Input Map
Channel Input
Clone Promotion Input
Club Member Enrollment Input
Club Membership Renewal Input
Corporate Member Enrollment Input
Coupon Usage Input
Eligible Clubs Input
Eligible Coupon Input
Eligible Enrollment Period Input
Eligible Loyalty Tiers Input
Events Detail Input
Individual Member Enrollment Input
Loyalty Engine Input
Loyalty Engine Input Map
Loyalty Engine Run Settings Input
Loyalty Account Input
Loyalty Contact Input
Loyalty Process Input
Loyalty Process Input Options
Loyalty Process Parameter Map Input
Loyalty View Transaction Journal History Input
Name And ID Input
Product Details
Promotion Eligible Channel Input
Promotion Eligibility Input
Promotion Input
Promotion Limit Input
Promotion Recommendation Input
Redeem Voucher Input
Related Promotion Records Input
Unified Promotions Input
Unified Promotion Template Input
Response Bodies
Loyalty Management Connect API Interchangeable Request Fields
Loyalty Management Standard Invocable Actions
Loyalty Management Custom Invocable Actions
Loyalty Management Metadata API Types
Loyalty Management Tooling API Objects
Loyalty Management Mobile SDK
Gamification Mobile SDK
Data Processing Engine, Batch Management, and Monitor Workflow Services
PDF

Individual Member Enrollment Input

Input representation for creating a person account and an Individual type Loyalty Program Member record for the member.
Root XML tag
<individualMemberEnrollment>
JSON example
{
  "enrollmentDate" : "2021-01-01T00:00:00",
  "membershipNumber" : "Member1",
  "associatedContactDetails" : {
    "firstName" : "Name1",
    "lastName" : "Name2",
    "email" : "ab@email.com",
    "allowDuplicateRecords" : "false",
    "additionalContactFieldValues" : {
      "attributes" : {
        "PersonMailingCity" : "Delhi",
        "CustomNumber__c" : "20.0"      }
    }
  },

  "memberStatus" : "Active",
  "referredBy" : "Member2",
  "referredByMemberReferralCode" : "MPX12adf",
  "createTransactionJournals" : "true",
  "transactionJournalStatementFrequency" : "Monthly",
  "transactionJournalStatementMethod" : "Mail",
  "enrollmentChannel" : "Email",
  "canReceivePromotions": "true",
  "canReceivePartnerPromotions" : "true",
  "membershipEndDate" : "2022-01-01T00:00:00",
  "relatedCorporateMembershipNumber" : "Member3",
  "additionalMemberFieldValues" : {
    "attributes" : {
      "CustomBoolean__c" : "true"    }
  }
}
Properties
Name Type Description Required or Optional Available Version
additionalMember​FieldValues Map<String, String> The custom attributes of the member in the loyalty program member record.
  • Keys
  • Values
 Required 55.0
associatedContactDetails Loyalty Contact Input The person account record details of the individual type member. Required 55.0
canReceivePartner​Promotions Boolean Indicates whether the member can receive partner promotions for the program (true) or not (false). Optional 55.0
canReceivePromotions Boolean Indicates whether the loyalty program member can receive promotions. Optional 55.0
createTransaction​Journals Boolean Indicates whether to create the transaction journal records (true) or not (false) :
The transaction journal records are created to:
  • Credit points to the member for enrolling.
  • Credit points to the member who has referred the new member.
Optional 55.0
enrollmentChannel String The channel used to by loyalty program member to enroll in to the loyalty program. Possible values are:
  • Pos
  • Web
  • Email
  • CallCenter
  • Social
  • Mobile
  • Store
  • Franchise
  • Partner
  • Print
 Optional 55.0
enrollmentDate Date The date on which the loyalty program members are enrolled in to the loyalty program.

The format is: 2020-09-08T00:00:00

 Required 55.0
memberStatus String The status of the loyalty program member. Possible values are:
  • Active
  • Inactive
  • Custom
 Required 55.0
membershipEndDate String The date on which the loyalty program member's membership ends. Optional 55.0
membershipNumber String The unique membership number of the loyalty program member. Required 55.0
referredBy String The membership number of the loyalty program member who has referred the member. Optional 55.0
referredByMemberReferralCode String The referral code of the loyalty program member who has referred the member. Optional 57.0
relatedCorporate​MembershipNumber String External corporate membership number of the member. Optional 55.0
transactionJournal​StatementFrequency String The frequency at which transaction journal statements must be delivered to the member. Possible values are:
  • Monthly
  • Quarterly
 Optional 55.0
transactionJournal​StatementMethod String The method used to deliver transaction journal statements to the member. Possible values are:
  • Mail
  • Email
 Optional 55.0