Skip to content

Latest commit

 

History

History
16 lines (12 loc) · 1.27 KB

NewReferralsForMultipleAdvocates.md

File metadata and controls

16 lines (12 loc) · 1.27 KB

TalonOne.NewReferralsForMultipleAdvocates

Properties

Name Type Description Notes
startDate Date Timestamp at which point the referral code becomes valid. [optional]
expiryDate Date Expiration date of the referral code. Referral never expires if this is omitted. [optional]
usageLimit Number The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.
campaignId Number The ID of the campaign from which the referral received the referral code.
advocateProfileIntegrationIds [String] An array containing all the respective advocate profiles.
attributes Object Arbitrary properties associated with this referral code. [optional]
validCharacters [String] List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. [optional]
referralPattern String The pattern used to generate referrals. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. [optional]