NewReferralsForMultipleAdvocates.md

TalonOne::NewReferralsForMultipleAdvocates

Properties

Name	Type	Description	Notes
start_date	DateTime	Timestamp at which point the referral code becomes valid.	[optional]
expiry_date	DateTime	Expiration date of the referral code. Referral never expires if this is omitted.	[optional]
usage_limit	Integer	The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.
campaign_id	Integer	The ID of the campaign from which the referral received the referral code.
advocate_profile_integration_ids	Array<String>	An array containing all the respective advocate profiles.
attributes	Object	Arbitrary properties associated with this referral code.	[optional]
valid_characters	Array<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]
referral_pattern	String	The pattern used to generate referrals. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set.	[optional]

Code Sample

require 'TalonOne'

instance = TalonOne::NewReferralsForMultipleAdvocates.new(start_date: 2020-11-10T23:00Z,
                                 expiry_date: 2021-11-10T23:00Z,
                                 usage_limit: 1,
                                 campaign_id: 45,
                                 advocate_profile_integration_ids: [URNGV8294NV, DRPVV9476AF],
                                 attributes: {"channel":"web"},
                                 valid_characters: [A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z],
                                 referral_pattern: REF-###-###)