Page Comparison

Manage and define new customer fields under the Customers tab. The data stored in the listed fields can be used in your loyalty program mechanisms as filters and synchronized to external systems as well.

...

• Click the ‘Create a new field’ option in the sidebar

• Define the unique ID
  The machine-readable ID of the field that needs to be referenced when sending API calls and in mathematical expressions. Once created, the ID of the field cannot be modified.

• Add the label
  The identifier of the field across the Backoffice - when creating segments, setting up rules, or looking at the customer profile.

• Add a description
  The description will appear under the customer field on the Personal information page of customer profiles in the Backoffice, where the value of the field is editable.

• Select the field type
  Select the type of data that is stored in the field. When sending the data through API, please make sure that it is sent in the format required by the selected type, otherwise the API request will fail.

  • String

  • Numeric

  • Boolean

  • Select
    Add the selectable options by defining possible values.

  • URL

  • Date
    A date value without a time part - YYYY-MM-DD

  • Datetime
    A date value with a time part - YYYY-MM-DD hh:mm:ss

  • Multiple choice
    Add the selectable options by defining possible values.

  • List

  • Image

• Default (only applicable for String, Numeric, Boolean and Url type attributes)
  You can enter a default value for customer fields.
  After the new customer attribute is added, the default value will be automatically populated in the new attribute of all customers.

• Format (only applicable for String and List types of fields)
  The format of values can be further specified to Date, URL, Email, Phone number formats, the API will validate the values accordingly.

• Tags
  Tags define the ways how attributes can be accessed and managed in the system.

  • API - the field is included in the response returned by the Customer API

  • searchable - any value of the field can be used as a search condition when requesting customer data through the Customer API

  • importable - the value of the field can be updated through the Imports module

  • groupable - the data values of the field can be grouped together when configuring charts to be displayed on the Dashboard

  • filterable - the field can be used as a filter condition when requesting customer data through the Customer API

  • unique - the same field value can only be registered once

  • Anchor
    external_id external_id

    external_ID - this field will be available through the Customer API within the ‘external_ids’ collection and can be used to identify customers in various Antavo API calls.

...

• Access Level
  Select the Access level that should apply to the customer field. Read more about Access levels below.

• Fieldset
  Select/create a group where the attribute will appear under the Personal information tab of the customer profile.

...

To make access levels effective, you need to make sure that your access levels are assigned to roles set up under the Roles tab of General settings.
All the access levels are automatically added to the Administrator role. To add access levels to further roles, you need to edit them and enable the options under the Permission mask section. All access levels are listed in the Permission mask with their labels.

...