Newer Version Available

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

Corporate Member Enrollments

Enroll corporate members in a loyalty program.
Resource
1/loyalty-programs/${loyaltyProgramName}/corporate-member-enrollments
Example
1https://yourInstance.salesforce.com/services/data/vXX.X
2/loyalty-programs/program1/corporate-member-enrollments
Available version
55.0
Requires Chatter
No
HTTP methods
POST
Request body for POST
Root XML tag
<corporateMemberEnrollment>
JSON example
1{
2    "enrollmentDate" : "2021-01-01T05:05:05",
3    "membershipNumber" : "Member123",
4    "associatedAccountDetails" : {
5        "name" : "Name1",
6        "phone" : "908989898",
7        "website" : "www.ab.com",
8        "allowDuplicateRecords" : "false",
9        "additionalAccountFieldValues" : {
10            "attributes" : {
11                "CustomNumber__c" : "20.0"
12            }
13        }
14    },
15    "memberStatus" : "Active",
16    "referredBy" : "Member12", 
17    "createTransactionJournals" : "true", 
18    "transactionJournal​StatementFrequency" : "Monthly", 
19    "additionalMember​FieldValues" : {
20        "attributes" : {
21            "CustomBoolean__c" : "true"
22        }
23    }
24}
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
Optional 55.0
associatedAccountDetails Loyalty Account Input The account details of the 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. 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 by members to enroll into a loyalty program.
Possible values are:
  • CallCenter
  • Email
  • Franchise
  • Mobile
  • Partner
  • Pos
  • Print
  • Social
  • Store
  • Web
Optional 55.0
enrollmentDate String The date on which a member is enrolled. Required 55.0
memberStatus String Status of the member. Possible values are:
  • Active
  • Inactive
  • Custom value
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 ID of the loyalty program member who has referred the member. Optional 55.0
transactionJournal​StatementFrequency String The frequency at which transaction journal statements must be delivered to the member. Possible values are:
  • Daily
  • Monthly
  • Yearly
Optional 55.0
transactionJournal​StatementMethod String The method used to deliver transaction journal statements to the member.
Possible values are:
  • Email
  • Mail
Optional 55.0
Response body for POST
Corporate Member Enrollment Output