You are here:
Partner Cloud | Get Referral Codes
Retrieves the referral codes associated with a user's contact. Use this action when a user wants to apply a referral code during deal registration. This action returns a list of referral codes including code name, description, and relevant details that the user can select from.
Action Details
| API Name | GetReferralCodes |
| Loading Text | Fetching referral codes |
Inputs
| Label | API Name | Description |
|---|---|---|
| Contact ID | contactId | The ID of the partner user whose referral codes are to be retrieved. |
Mapped to Variable: Contact ID
Outputs
| Label | API Name | Description |
|---|---|---|
| Lead Record Types | leadRecordTypes | A JSON string of referral code objects available to the user's contact. Each object contains referralCode (the code string to apply to the Lead), programName (name of the loyalty program the code belongs to), expirationDate (ISO date string of when the code expires, empty if no expiration), voucherType (type of voucher, for example, FixedValue, DiscountPercentage, ProductService), and incentiveDescription (human-readable description of the benefit). Only includes codes whose voucher EffectiveDate is on or after today and haven't yet expired. Present these to the user so they can select one to apply to the lead. |
Did this article solve your issue?
Let us know so we can improve!
