Skip to content

Latest commit

 

History

History
88 lines (45 loc) · 3.26 KB

Attribute.md

File metadata and controls

88 lines (45 loc) · 3.26 KB
Raw

TalonOne.Attribute

Properties

Name Type Description Notes
id Number Internal ID of this entity.
created Date The time this entity was created.
accountId Number The ID of the account that owns this entity.
entity String The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an `attributes` object with keys corresponding to the `name` of the custom attributes for that type.
eventType String [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 human-readable name for the attribute that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique.
type String The data type of the attribute, a `time` attribute must be sent as a string that conforms to the RFC3339 timestamp format.
description String A description of this attribute.
suggestions [String] A list of suggestions for the attribute.
hasAllowedList Boolean Whether or not this attribute has an allowed list of values associated with it. [optional] [default to false]
restrictedBySuggestions Boolean Whether or not this attribute's value is restricted by suggestions (`suggestions` property) or by an allowed list of value (`hasAllowedList` property). [optional] [default to false]
editable Boolean Whether or not this attribute can be edited.
subscribedApplicationsIds [Number] A list of the IDs of the applications where this attribute is available. [optional]
subscribedCatalogsIds [Number] A list of the IDs of the catalogs where this attribute is available. [optional]
allowedSubscriptions [String] A list of allowed subscription types for this attribute. Note: This only applies to attributes associated with the `CartItem` entity. [optional]
eventTypeId Number [optional]

Enum: EntityEnum

  • Application (value: "Application")

  • Campaign (value: "Campaign")

  • CustomerProfile (value: "CustomerProfile")

  • CustomerSession (value: "CustomerSession")

  • CartItem (value: "CartItem")

  • Coupon (value: "Coupon")

  • Event (value: "Event")

  • Giveaway (value: "Giveaway")

  • Referral (value: "Referral")

  • Store (value: "Store")

Enum: TypeEnum

  • string (value: "string")

  • number (value: "number")

  • boolean (value: "boolean")

  • time (value: "time")

  • (list string) (value: "(list string)")

  • (list number) (value: "(list number)")

  • (list time) (value: "(list time)")

  • location (value: "location")

  • (list location) (value: "(list location)")

Enum: [AllowedSubscriptionsEnum]

  • application (value: "application")

  • catalog (value: "catalog")