Newer Version Available

This content describes an older version of this product. View Latest

ConnectApi.IndividualMemberInput

Input representation of the individual member create request.
Property Type Description Required or Optional Available Version
additionalMember​FieldValues Map<String, String> The custom field values in the loyalty program member record.
  • Keys
  • Values
Required 55.0
associatedContact​Details ConnectApi.LoyaltyContactInputRepresentation The contact record 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 member can receive promotions for the program (true) or not (false). 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 individual member for enrolling in the loyalty program.
  • Credit points to the member who has referred the individual member.
Optional 55.0
enrollmentChannel ConnectApi.​EnrollmentChannelResource The channel used by members to enroll into the loyalty program.
Possible values are:
  • CallCenter
  • Email
  • Franchise
  • Mobile
  • Partner
  • Pos
  • Print
  • Social
  • Store
  • Web
Optional 55.0
enrollmentDate Datetime The date on which a member is enrolled. The format is: YYYY-MM-DDTHH:MM:SS. Required 55.0
memberStatus String The status of the member.
Possible values are:
  • Active
  • Inactive
  • Custom value
Required 55.0
membershipEndDate Datetime 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
relatedCorporate​MembershipNumber String The external corporate membership of the member. Optional 55.0
transactionJournal​StatementFrequency ConnectApi.​StatementFrequencyResource The frequency at which transaction journal statement must be delivered to the member.
Possible values are:
  • Monthly
  • Quaterly
Optional 55.0
transactionJournal​StatementMethod ConnectApi.​StatementMethodResource The method used to deliver transaction journal statements to the member.
Possible values are:
  • Email
  • Mail
Optional 55.0