Referral Advocate Enrollment Input

Input representation of the request to enroll an advocate to a referral promotion.

Root XML tag

referralMemberEnrollmentInput

JSON examples to enroll an existing referral program advocate to a promotion

1{
2   "membershipNumber":"M125"
3}

1{
2  "contactId": "003xx000004Wsxc"
3}

1{
2  "associatedPersonAccountDetails": {
3    "firstName": "Mac",
4    "lastName": "Ray",
5    "email": "mray@salesforce.com",
6    "allowDuplicateRecords": "false",
7    "additionalPersonAccountFieldValues": {
8      "attributes": {
9        "country__c": "US"
10      }
11    }
12  },
13  "memberStatus": "Active",
14  "transactionJournalStatementFrequency": "Monthly",
15  "transactionJournalStatementMethod": "Mail",
16  "enrollmentChannel": "Email",
17  "additionalMemberFieldValues": {
18    "attributes": {
19      "state__c": "California"
20    }
21  }
22}

JSON example to enroll a new customer as an advocate of a promotion

1{
2  "membershipNumber": "M125",
3  "associatedPersonAccountDetails": {
4    "firstName": "Mac",
5    "lastName": "Ray",
6    "email": "mray@salesforce.com",
7    "allowDuplicateRecords": "false",
8    "additionalPersonAccountFieldValues": {
9      "attributes": {
10        "country__c": "US"
11      }
12    }
13  },
14  "memberStatus": "Active",
15  "transactionJournalStatementFrequency": "Monthly",
16  "transactionJournalStatementMethod": "Mail",
17  "enrollmentChannel": "Email",
18  "additionalMemberFieldValues": {
19    "attributes": {
20      "state__c": "California"
21    }
22  }
23}

Properties

Name	Type	Description	Required or Optional	Available Version
`additionalMemberFieldValues`	Map<String, String>	Custom field values of the advocate.	Optional	59.0
`additionalPersonAccountFieldValues`	Map<String, String>	Custom field values from the advocate's person account.	Optional	59.0
`associatedPersonAccountDetails`	Person Account Input	Details of the advocate's person account.	Optional This field is required only if you don’t have the contact ID or the membership number of the advocate.	59.0
`contactId`	String	Contact ID of the advocate to enroll to the referral promotion.	Optional This field is required only if you don’t have the person account details or the membership number of the advocate.	59.0
`enrollmentChannel`	String	Channel that the advocate has used to join the referral program. Possible values are: `CallCenter` `Email` `Franchise` `Mobile` `Partner` `Pos` `Print` `Social` `Store` `Web`	Optional	59.0
`memberStatus`	String	Status of the new advocate after enrollment. Possible values are: `Active` `Inactive` Custom value - Any value you define in your org. For example, if an advocate must be evaluated before confirming enrollment, you can create a status called `On Hold` and assign it to this field. The default value is `Active`.	Optional This field is required for enrolling a new advocate.	59.0
`membershipEndDate`	String	Date the advocate's referral program membership ends.	Optional	59.0
`membershipNumber`	String	Unique membership number of the advocate.	Optional This field is required only if you don’t have the person account details or the contact ID of the advocate.	59.0
`shouldProcessTransactionsInRealTime`	Boolean	Indicates whether the transaction journals created by the API are processed as soon as they’re created (`true`) or not (`false`). The default value is `true`.	Optional	59.0
`transactionJournalStatementFrequency`	String	Frequency at which transaction statements must be generated for the advocate. Possible values are: `Monthly` `Quarterly`	Optional	59.0
`transactionJournalStatementMethod`	String	Preferred method of receiving transaction journal statements. Possible values are: `Email` `Mail`	Optional	59.0

Referral Marketing Developer Guide

Referral Advocate Enrollment Input