Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 1.9 KB

TalangAttribute.md

File metadata and controls

55 lines (40 loc) · 1.9 KB

TalangAttribute

Properties

Name Type Description Notes
entity EntityEnum The name of the entity of the attribute. [optional]
name String The attribute name that will be used in API requests and Talang. E.g. if `name == "region"` then you would set the region attribute by including an `attributes.region` property in your request payload.
title String The name of the attribute that is displayed to the user in the Campaign Manager. [optional]
type String The talang type of the attribute.
description String A description of the attribute. [optional]
visible Boolean Indicates whether the attribute is visible in the UI or not.
kind KindEnum Indicate the kind of the attribute.
campaignsCount Integer The number of campaigns that refer to the attribute.
exampleValue List<String> Examples of values that can be assigned to the attribute. [optional]

Enum: EntityEnum

Name Value
ADVOCATEPROFILE "AdvocateProfile"
ACCOUNT "Account"
APPLICATION "Application"
AWARDEDGIVEAWAY "AwardedGiveaway"
BUNDLE "Bundle"
CAMPAIGN "Campaign"
CARTITEM "CartItem"
COUPON "Coupon"
CUSTOMERPROFILE "CustomerProfile"
CUSTOMERSESSION "CustomerSession"
EVENT "Event"
ITEM "Item"
LOYALTY "Loyalty"
PROFILE "Profile"
GIVEAWAY "Giveaway"
REFERRAL "Referral"
SESSION "Session"
STORE "Store"
ACHIEVEMENTS "Achievements"

Enum: KindEnum

Name Value
BUILT_IN "built-in"
CUSTOM "custom"