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

NameTypeDescriptionRequired or OptionalAvailable Version
additional​Member​FieldValuesMap<String, String>The custom attributes of the member in the loyalty program member record. Keys or Values.Required55.0
associatedContact​DetailsLoyalty Contact InputThe person account record details of the individual type member.Required55.0
can​Receive​Partner​PromotionsBooleanIndicates whether the member can receive partner promotions for the program (true) or not (false).Optional55.0
can​Receive​PromotionsBooleanIndicates whether the loyalty program member can receive promotions.Optional55.0
create​Transaction​JournalsBooleanIndicates 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.
Optional55.0
enrollment​ChannelStringThe 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
Optional55.0
enrollment​DateDateThe 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.Required55.0
memberStatusStringThe status of the loyalty program member. Possible values are Active, Inactive, or Custom.Required55.0
membership​EndDateStringThe date on which the loyalty program member’s membership ends.Optional55.0
membership​NumberStringThe unique membership number of the loyalty program member.Required55.0
processAsyncBooleanIndicates whether to process the enrollment asynchronously (true) or synchronously (false). If true, the API validates the request, creates or finds the person account, and creates the loyalty program member record with the Provisioning member status. The API then returns a response without transaction journals, and Loyalty Management completes the enrollment in the background. Loyalty Management creates the member’s default tier and currency records, as synchronous enrollment does. If createTransactionJournals is true, it also creates the transaction journals. Finally, it changes the member status to the memberStatus value in the request. Until the status changes, the member has no tier or currency records. If the background processing fails, the member status stays Provisioning. If false, the API completes all enrollment tasks before it returns the response. The default value is false.Optional69.0
referredByStringThe membership number of the loyalty program member who has referred the member.Optional55.0
referred​ByMember​ReferralCodeStringThe referral code of the loyalty program member who has referred the member.Optional57.0
related​Corporate​MembershipNumberStringExternal corporate membership number of the member.Optional55.0
transaction​JournalStatement​FrequencyStringThe frequency at which transaction journal statements must be delivered to the member. Possible values are Monthly or Quarterly.Optional55.0
transaction​JournalStatement​MethodStringThe method used to deliver transaction journal statements to the member. Possible values are Mail or Email.Optional55.0

Individual Member Enrollment