Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.86 KB

CreateReferralBlock.md

File metadata and controls

24 lines (17 loc) · 1.86 KB

CreateReferralBlock

A block that creates a referral code.

Properties

Name Type Description Notes
id String Unique identifier for this block. [optional] [readonly]
type String Identifies the block variant and determines which additional properties are present in it.
tags List<String> Semantic labels attached to this block. [optional] [readonly]
campaignId Object The ID of the campaign in which the referral code is created. Either a numeric scalar or a `{{expression}}` string that resolves to a number at evaluation time.
friendId String An optional integration ID of the friend's profile.
storeInSession Boolean When `true`, the referral code is stored in the session.
usageLimit Object The number of times the referral code code can be redeemed. `0` means unlimited redemptions, but any campaign usage limits still apply. Either a numeric scalar or a `{{expression}}` string that resolves to a number at evaluation time. [optional]
startDate Object Timestamp at which point the referral code becomes valid. [optional]
expiryDate Object Expiration date of the referral code. Referral code never expires if this is omitted. [optional]
attributes Object Custom attributes associated with this referral code. [optional]
validCharacters String Characters used to generate the random parts of a code. [optional]
pattern String The pattern used to generate codes, such as coupon codes, referral codes, and loyalty cards. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. [optional]