Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 1.98 KB

CreateCouponBlock.md

File metadata and controls

25 lines (18 loc) · 1.98 KB

CreateCouponBlock

A block that creates a coupon 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 coupon code is created.
recipientId String The integration ID of the customer that is allowed to redeem this coupon.
storeInSession Boolean When `true`, the coupon is stored in the session.
usageLimit Object The number of times the coupon 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]
discountLimit Object The total discount value that the code can give. Typically used to represent a gift card value. Either a numeric scalar or a `{{expression}}` string that resolves to a number at evaluation time. [optional]
startDate Object Timestamp at which point the coupon becomes valid. [optional]
expiryDate Object Expiration date of the coupon. Coupon never expires if this is omitted. [optional]
attributes Object Custom attributes associated with this coupon 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]