Skip to main content

Managing attributes

Attributes are the key to customizing your rules as much as you want. Use attributes to represent any information about the following entities:

  • Application
  • Campaign
  • Cart Item
  • Coupon
  • Customer profile
  • Customer session
  • Event
  • Giveaway
  • Referral
  • Store
Feature access
Only admins and Application admins have access to this feature.

Attributes are Application-specific, used inside rules (usually inside conditions), and described by:

  • Their type (number, string, list, etc.)
  • Their definition (Built-in or Custom attribute)
  • Their name
  • The entity they belong to in the above list

Built-in and custom attributes

The attribute definition describes the nature of an attribute. Talon.One supports built-in and custom attributes.

Attribute definitionDescription
Built-in attributeProvided by default, such as the name of a customer or the value of a coupon. You can view them in the attribute library and find them in the Rule Builder. Not all built-in attributes are available by default, but admins can enable them.
Custom attributeWhen the built-in attributes do not represent the data of your business activity, you can create your own attributes, called custom attributes.

Example

Let's imagine you own a bike-rental business. Users can get free minutes if they return their rental bikes to certain locations.

An obvious rule for this would be:

  • Condition: if the bike location at the end of the rental is one of the special locations then...
  • Effect: Award x minutes to the customer profile.

Talon.One does not provide a minutes attribute for customer profiles, so we can create a custom attribute to represent this data. We can call it minutes, it is a number, and it is associated with the customer profile entity.

Creating a custom attribute

To send specific data to Talon.One, create custom attributes, set a value for them via the Integration API or via the Campaign Manager and use them in your Rules.

To create a custom attribute:

  1. On the leftmost menu, Account.

  2. Click Tools > Attributes.

  3. Click Create Attribute at the top-right of the page.

  4. In Associated entity, choose the entity that will own the attribute.

  5. In Attribute type, choose the type of value assigned to the attribute:

    • String
    • Number
    • Boolean
    • Time
    • Location
    • List of strings
    • List of numbers
    • List of dates
    • List of locations
  6. In API name, type the name of the attribute as you will use it in the integration layer. See the Developer docs.

  7. In Rule Builder name, type the name of the attribute as it will appear in the Rule Builder.

  8. In Rule Builder description, type a description of what the attribute represents. It will appear in the Rule Builder.

  9. (Optional) In Picklist Values:

    • In Enter picklist values, enter a list of values for the attribute.
    • If you have to enter more than 50 values, in Import picklist values, upload a CSV file with up to 500,000 values. Imports override previous ones and any manually entered values.
    • (Optional) Tick the checkbox above Enter picklist values to allow users to enter their own values when using the attribute in the Rule Builder. By default, users are only able to use picklist values once you import or manually enter some.
    note

    See Picklist values to learn more.

  10. In Connected Application(s), select the Applications where you want to use the attribute.

    note
    • Admins can leave this blank to make the attribute available in all Applications.
    • If the entity associated to the attribute is Cart Item and you have created one or more cart item catalogs, you can also connect your attribute to any Catalogs available in your account.
  11. Click Create Attribute.

This attribute is ready to be used but has no value yet.

note

Custom attributes associated with the store entity are connected to all the stores in an Application.

Picklist values

Use this feature to select predefined values from a drop-down menu when using attributes in the Rule Builder. Picklist values are available in conditions and cart item filters. They are useful to prevent mistakes when setting up campaigns involving many items.

For example, if your business is a supermarket and you want to create campaigns based on items in the cart, you can create a cart item custom attribute called pizza and add values such as pizza carbonara, pizza salami and pizza veggie, or a list of SKUs.

When creating custom attributes, you can decide whether users creating rules can add their own values or just pick predefined values from a list.

note

Picklist values are not available for boolean and location attributes.

Catalog-based picklist values

If you created a cart item catalog and connected it to an Application, the values of the attributes of the cart items in the catalog are available in the Rule Builder in all the campaigns in the Application.

note

The SKU values of the cart items in the catalog are also available as picklist values for any SKUs you reference in your rules.

Setting the value of an attribute

After you create an attribute, you can set its value. The way you can set its value depends on the associated entity.

EntityHow to set the attribute values
ApplicationIn the Application settings.
CampaignIn the settings of the campaign.
Cart itemProgrammatically, using the Update customer session endpoint. See an example in the Developer docs.
CouponWhen you create a coupon via the Campaign Manager. Programmatically during import or using the Update customer session endpoint.
Customer profileProgrammatically, using the Update customer profile endpoint.
Customer sessionProgrammatically, using the Update customer session endpoint.
EventProgrammatically, using the Track event V2 endpoint.
GiveawayWhen you import a giveaway. Programmatically, during import or using the Update customer session endpoint.
ReferralWhen you generate a referral as an effect. Programmatically, during creation or using the Update customer session endpoint.
StoreProgrammatically, using the Create store endpoint for a new store and the Update store endpoint for an existing store.

Also see an example in the Developer docs.

Sorting attributes

You can sort the items on the Attributes page by clicking Sort By and selecting one of the available sorting options.

Filtering attributes

You can use different criteria to filter your attributes and find specific ones. For example, you can filter by the entity associated with the attribute.

To filter attributes:

  1. On the leftmost menu, click Account.

  2. Click Tools > Attributes.

  3. Click Filter at the top of the page to display the filtering options:

    • You can use Entity to find all the attributes associated with the same type of entity.
    • You can use Type to find attributes corresponding to a certain type of value.
    • You can use Show attributes to only display built-in attributes or custom ones.
    note

    You can use more than one filter at the same time. The filters used appear at the top of the page, and you can edit them by clicking on the box with their name. You can also remove them individually by clicking the X to the right of their name.

You see the table rows containing the attributes that match the filters you have set.

tip

To see all the available attributes again, click Clear Filters.

Managing attribute visibility

Depending on your attribute usage, you can control the visibility of attributes in the Attribute Selector. For example, you can hide outdated or irrelevant attributes to make finding attributes easier.

To manage attribute visibility:

  1. On the leftmost menu, click Account.
  2. Click Tools > Attributes.
  3. In the Visibility column, click to toggle the status for the required attribute:
    • Enabled: The attribute is visible, and you can select it in the Attribute Selector.
    • Disabled: The attribute is hidden. It appears in the search results of the Attribute Selector, but you cannot select it.
      note

      Hidden attributes still appear in the rules in which they are used.

Editing a custom attribute

You can modify some characteristics of a coupon after it has been created. For example, you can modify the description or edit picklist values.

Important

Application admins can edit custom attributes that are available only in Applications of which they are an admin.

To edit a custom attribute:

  1. On the leftmost menu, click Account.

  2. Click Tools > Attributes.

  3. Use the search bar and the filters at the top to search for the required attribute.

  4. Click the title of the attribute you want to edit.

  5. Edit the required information (Rule Builder name and description, picklist values, and connected Applications).

    note

    If you imported a CSV file with picklist values, you can download it to check the values it contains. If you import a new CSV file, it overrides any manually entered values and previous imports.

  6. Click Update attribute.

Deleting a custom attribute

You can delete your custom attributes but not the built-in ones.

Important
  • Deleting a custom attribute can break your integration with Talon.One. Before deleting an attribute, ensure it is not being used in your API requests. If you are not sure, contact your development team for details or consider hiding the attribute instead.
  • You cannot delete a custom attribute if you are using it.
  • Application admins can delete custom attributes that are available only in Applications of which they are an admin.

To delete a custom attribute:

  1. On the leftmost menu, click Account.
  2. Click Tools > Attributes.
  3. Use the search bar and the filters at the top to search for the required attribute.
  4. Click the title of the attribute you want to delete.
  5. At the bottom of the page, click Delete Attribute.
  6. On the confirmation window that appears, enter the API name of the attribute and click Delete Attribute.