Individual Member Enrollments
Enroll individual members in a loyalty program. Create a person account and an Individual type loyalty program member record for the new member.
To use this resource, Person Accounts must be enabled in your org. The profile of the user who executes the resource must have Person Account selected as the default record type for person accounts. If the profile of the user has a different record type selected as the default record type for person accounts, an Account record of the selected record type is created for the member.
55.0
No
POST
Root XML Tag
<individualMemberEnrollment>
JSON Example
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
additionalMemberFieldValues | Map<String, String> | The custom attributes of the member in the loyalty program member record. Keys or Values. | Required | 55.0 |
associatedContactDetails | Loyalty Contact Input | The person account record details of the individual type member. | Required | 55.0 |
canReceivePartnerPromotions | 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 |
createTransactionJournals | Boolean | Optional | 55.0 | |
enrollmentChannel | String | The channel used to by loyalty program member to enroll in to the loyalty program. | Optional | 55.0 |
enrollmentDate | 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, or 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 |
relatedCorporateMembershipNumber | String | External corporate membership number of the member. | Optional | 55.0 |
transactionJournalStatementFrequency | String | The frequency at which transaction journal statements must be delivered to the member. Possible values are Monthly or Quarterly. | Optional | 55.0 |
transactionJournalStatementMethod | String | The method used to deliver transaction journal statements to the member. Possible values are Mail or Email. | Optional | 55.0 |
Indicates whether to create the transaction journal records ( <codeph otherprops=“nolang”>true</codeph> ) or not ( <codeph otherprops=“nolang”>false</codeph> ). 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.
Possible values are:
PosWebEmailCallCenterSocialMobileStoreFranchisePartnerPrint