| Name | Type | Description | Notes |
|---|---|---|---|
| entity | EntityEnum | 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 | TypeEnum | 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 | List<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] |
| 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] |
| editable | Boolean | Whether or not this attribute can be edited. | |
| subscribedApplicationsIds | List<Integer> | A list of the IDs of the applications where this attribute is available. | [optional] |
| subscribedCatalogsIds | List<Integer> | A list of the IDs of the catalogs where this attribute is available. | [optional] |
| allowedSubscriptions | List<AllowedSubscriptionsEnum> | A list of allowed subscription types for this attribute. Note: This only applies to attributes associated with the `CartItem` entity. | [optional] |
| Name | Value |
|---|---|
| APPLICATION | "Application" |
| CAMPAIGN | "Campaign" |
| CUSTOMERPROFILE | "CustomerProfile" |
| CUSTOMERSESSION | "CustomerSession" |
| CARTITEM | "CartItem" |
| COUPON | "Coupon" |
| EVENT | "Event" |
| GIVEAWAY | "Giveaway" |
| REFERRAL | "Referral" |
| STORE | "Store" |
| Name | Value |
|---|---|
| STRING | "string" |
| NUMBER | "number" |
| BOOLEAN | "boolean" |
| TIME | "time" |
| LIST_STRING | "(list string)" |
| LIST_NUMBER | "(list number)" |
| LIST_TIME | "(list time)" |
| LOCATION | "location" |
| LIST_LOCATION | "(list location)" |
| Name | Value |
|---|---|
| APPLICATION | "application" |
| CATALOG | "catalog" |