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
1{
2  "enrollmentDate" : "2021-01-01T00:00:00",
3  "membershipNumber" : "Member1",
4  "associatedContactDetails" : {
5    "firstName" : "Name1",
6    "lastName" : "Name2",
7    "email" : "ab@email.com",
8    "allowDuplicateRecords" : "false",
9    "additionalContactFieldValues" : {
10      "attributes" : {
11        "PersonMailingCity" : "Delhi",
12        "CustomNumber__c" : "20.0"      }
13    }
14  },
15
16  "memberStatus" : "Active",
17  "referredBy" : "Member2",
18  "referredByMemberReferralCode" : "MPX12adf",
19  "createTransactionJournals" : "true",
20  "transactionJournalStatementFrequency" : "Monthly",
21  "transactionJournalStatementMethod" : "Mail",
22  "enrollmentChannel" : "Email",
23  "canReceivePromotions": "true",
24  "canReceivePartnerPromotions" : "true",
25  "membershipEndDate" : "2022-01-01T00:00:00",
26  "relatedCorporateMembershipNumber" : "Member3",
27  "additionalMemberFieldValues" : {
28    "attributes" : {
29      "CustomBoolean__c" : "true"    }
30  }
31}
Properties
Name Type Description Required or Optional Available Version
additional​Member​FieldValues Map<String, String> The custom attributes of the member in the loyalty program member record.
  • Keys
  • Values
Required 55.0
associatedContact​Details Loyalty Contact Input The person account record details of the individual type member. Required 55.0
can​Receive​Partner​Promotions Boolean Indicates whether the member can receive partner promotions for the program (true) or not (false). Optional 55.0
can​Receive​Promotions Boolean Indicates whether the loyalty program member can receive promotions. Optional 55.0
create​Transaction​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
enrollment​Channel 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
enrollment​Date Date The date on which the loyalty program member is enrolled in to the loyalty program.

The format is: YYYY-MM-DDTHH:mm:ss. For example: 2020-09-08T00:00:00.

This field must be provided in the org’s configured timezone, not in Central UTC. The system doesn't convert this value from UTC to org timezone internally. In other words, the provided datetime already represents the correct org-local enrollment date and time.

Required 55.0
memberStatus String The status of the loyalty program member. Possible values are:
  • Active
  • Inactive
  • Custom
Required 55.0
membership​EndDate String The date on which the loyalty program member's membership ends. Optional 55.0
membership​Number 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
referred​ByMember​ReferralCode String The referral code of the loyalty program member who has referred the member. Optional 57.0
related​Corporate​MembershipNumber String External corporate membership number of the member. Optional 55.0
transaction​JournalStatement​Frequency String The frequency at which transaction journal statements must be delivered to the member. Possible values are:
  • Monthly
  • Quarterly
Optional 55.0
transaction​JournalStatement​Method String The method used to deliver transaction journal statements to the member. Possible values are:
  • Mail
  • Email
Optional 55.0