Customers

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.

Fields

By navigating to the Customers tab, first you’ll find the list of fields that are currently available in the customer object with the following information:

• Label of the field

• Unique ID of the field

• Field type

• Built-in

  • yes - factory fields provided by default

  • no - custom fields added on the platform

• Tags associated with the field

Open

Add a new field

• 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

  • 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.

Open

Set data & privacy control rules

• Required
  If the attribute is ‘required’, make sure to add a default value to this attribute in the valid format. If the value of the required item is empty, you will not be able to make any further updates to the customer through the profile event without adding a value to the item in the correct format.
  However, customers can still be updated through the Modify event workflow node, even if the required field is not populated.

• Computed
  By checking this box the field won’t be displayed on the customer profile in the Backoffice.

• Sensitive
  The value of sensitive fields won’t be displayed on the customer profile automatically, you need to enter your Backoffice login credentials to view them.

Make sure you click ‘Save’ before leaving the page.

Edit fields

Edit configured fields anytime except for the Unique ID. Click the ‘Edit’ button in the field list to edit a field. Use the search bar if necessary.

If you have set a default value or modified a previously added default value while editing the customer field, the value of the attribute will be populated on all customers if the attribute was empty or populated with a previously configured default value.

Delete fields

Customer fields cannot be deleted, but you can stop using them in your loyalty program. Before you do, make sure that the ‘Required’ checkbox is not ticked in the editing interface.

Access levels

Access levels let you define the group of platform users who should view and edit specific customer attributes.

Under the Access levels tab, first you’ll find the list of access levels that has been added with the following information:

• Label

• The Backoffice user who created the access level linked to the user profile

• Creation date

Add a new access level

• Click the ‘Create a new access level’ option in the sidebar

• Define the unique ID
  The machine-readable ID of the access level. Once created, the ID of the access level cannot be modified.

• Add the label
  This is how you identify the access level across the Backoffice, when adding it to Roles and Customer fields.

• Click ‘Save’

Edit access levels

Edit the label of the access level anytime by clicking the ‘Edit’ button in the field list to edit a field. Use the search bar if necessary.

Delete access levels

Access levels cannot be deleted, but you can stop using them.

Add access levels to roles

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.

Settings

Under the Settings tab, you can define basic settings that affect all customers.

Minimum age

This feature is useful if you’d like to prevent the registration of minors in the loyalty program.

• Enable the age limit by turning on the radio button
  If enabled, the Birth date field is a required attribute of the Optin event.

• Define the age limit in years
  The age limit must be at least 13 years. If the Birth date value of the Optin event is less than the minimum age the event will be rejected by Antavo.

Make inactive customer data available through API

If this option is enabled, the endpoints of the Customer API will return the data of not only active customers but inactive customers as well, who have not been registered in the loyalty program through an Optin event.
Read more about customer statuses here.

Before leaving the page, please click ‘Save' to make sure your changes are effective.