Referral Advocate Enrollments

Special Access Rules

To use this resource, your org must have person accounts enabled.

Resource

Resource example

Available version

59.0

Requires Chatter

No

HTTP methods

POST

Request body for POST

Root XML tag

referralMemberEnrollmentInput

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

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

Properties

Name	Type	Description	Required or Optional	Available Version
additionalMember​FieldValues	Map<String, String>	Custom field values of the advocate.	Optional	59.0
additionalPerson​AccountFieldValues	Map<String, String>	Custom field values from the advocate's person account.	Optional	59.0
associatedPerson​AccountDetails	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
shouldProcess​TransactionsInRealTime	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
transactionJournal​StatementFrequency	String	Frequency at which transaction statements must be generated for the advocate. Possible values are: Monthly Quarterly	Optional	59.0
transactionJournal​StatementMethod	String	Preferred method of receiving transaction journal statements. Possible values are: Email Mail	Optional	59.0

Response body for POST

Referral Member Enrollment Output