ReferralAPIManager | Referral Marketing Developer Guide

Methods

referralEnrollment

Enroll an existing member to a given promotion using the membership number.

1public func referralEnrollment(membershipNumber: String,
2                                   promotionCode: String,
3                                   memberStatus: String = MemberStatus.active.rawValue,
4                                   version: String = ReferralAPIVersion.defaultVersion,
5                                   devMode: Bool = false) async throws -> ReferralEnrollmentOutputModel

Enroll an existing member to a given promotion using the contact ID.

1public func referralEnrollment(contactID: String,
2                                   promotionCode: String,
3                                   memberStatus: String = MemberStatus.active.rawValue,
4                                   version: String = ReferralAPIVersion.defaultVersion,
5                                   devMode: Bool = false) async throws -> ReferralEnrollmentOutputModel

Enroll a new member to a given promotion.

1public func referralEnrollment(firstName: String,
2                                   lastName: String,
3                                   email: String,
4                                   membershipNumber: String,
5                                   promotionCode: String,
6                                   enrollmentChannel: ReferralEnrollmentChannel = ReferralEnrollmentChannel.mobile,
7                                   memberStatus: String = MemberStatus.active.rawValue,
8                                   tjStatementFrequency: TransactionJournalStatementFrequency = .monthly,
9                                   tjStatementMethod: TransactionJournalStatementMethod = .email,
10                                   version: String = ReferralAPIVersion.defaultVersion,
11                                   devMode: Bool = false) async throws -> ReferralEnrollmentOutputModel

Parameter	Type	Description
`contactID`	String	Required. The contact ID of the existing member. Provide either the contact ID, the membership number, or the person account details (first name, last name, and email), and not all.
`country`	String	The name of the country of the member.
`devMode`	Boolean	Indicates whether the method is run in the developer mode (`true`) or not (`false`).
`email`	String	Required. The email ID of the member.
`enrollmentChannel`	String	Channel used to join the referral program. Possible values are: `CallCenter` `Email` `Franchise` `Mobile` `Partner` `Pos` `Print` `Social` `Store` `Web` The default value is `Email`.
`firstName`	String	Required. The first name of the member. Provide either the contact ID, the membership number, or the person account details (first name, last name, and email), and not all.
`lastName`	String	Required. The last name of the member. Provide either the contact ID, the membership number, or the person account details (first name, last name, and email), and not all.
`memberStatus`	String	Status of the new advocate after enrollment. Possible values are: `Active` `Inactive` Custom value - Any value defined 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`.
`membershipNumber`	String	Required. The membership number of the existing member. Provide either the contact ID, the membership number, or the person account details (first name, last name, and email), and not all.
`promotionCode`	String	Required. The promotion code to enroll for.
`state`	String	The name of the state of the member.
`transactionalJournalFrequency`	String	The frequency at which transaction statements must be generated for the advocate. Possible values are: `Monthly` `Quarterly` The default value is `Monthly`.
`transactionalJournalMethod`	String	Preferred method of receiving transaction journal statements. Possible values are: `Email` `Mail` The default value is `Email`.
`version`	String	The API version.

referralEvent

Send referral emails to the given recipients.

1public func referralEvent(emails: [String],
2                              referralCode: String,
3                              eventType: ReferralEventType = .refer,
4                              version: String = ReferralAPIVersion.defaultVersion,
5                              devMode: Bool = false) async throws -> ReferralEventOutputModel

Parameter	Type	Description
`devMode`	Boolean	Indicates whether the method is run in the developer mode (`true`) or not (`false`).
`emails`	String[]	Required. A list of recipient emails to share the referral code with.
`eventType`	String	The type of event. Possible values are: `Enrollment` `Purchase` `Refer` The default value is `Refer`.
`referralCode`	String	Required. The referral code to share with the recipients.
`version`	String	The API version.