Create and Manage Custom Fields

Create a new custom field

To create a new custom field, click on your Settings and select "Custom Fields" or go to this URL.

Then, click on the blue circle at the bottom left and select "Add Custom Field":

You will be prompted to enter the details for the new custom field:

• Name – Enter a unique name for the field. You can change that later, note, however, that the API name and the merge tag for the field will not update.
  
  Once you enter a name, a unique API name will be automatically generated for that field. You can use this name to address this field when making calls to the Encharge API.
  
  This name is also used as a marge tag for the field. For instance, {{person.NewcustomField}}.
  
  This API and merge tag name can not be changed later. If you need to change it, please contact support.
  
  

  

• Type – supported field types are Text, Number, "True or False", and "Date and time" fields. 

• Description (optional) – a description can help you identify the field. Field descriptions show as tooltips when you hover on the field name at various places across the platform

Once you're done, click on the "Create" button. Your field will be added to the bottom of the table on the "All Fields" tab.

Important: A single field's maximum character is up to 5000 and the sum of all fields on a single person can be up to 200 kb.

Field types

Date and time

All date and time fields must have a date and a time. If you send the date only to a "Date and time" field, the system will automatically record the time as 00:00.

Edit a custom field

To edit a custom field, click on the three dots to the left of the field name and select Edit.

Note that:

• Default fields can't be edited.
• Editing an existing field that is currently in use in Flows will be updated in the Flow steps. The steps will display the new name of the field.
• The merge tag for the field will not be updated – the field will always use the original merge tag.
  
  For instance, if you change the name of "New Custom Field" to "Custom Field Updated" the merge tag for this field will continue to be {{person.NewCustomField}}.
  
  Therefore, if you change a field name, you don't need to update merge tags across your emails as the field will still use the old merge tag.
• Similarly, the API name will not be updated – it will always use the original API name. For instance, NewCustomField.

Archive a custom field

To archive a custom field, click on the three dots to the left of the field name and select Archive.

Note that archiving a custom field will only hide it from the interface of the platform. It will not remove any existing uses of the field across your Flows, segments, or emails, nor will remove any data from people's profiles.

In other words, you won't be able to see the field in people's profiles or configure any new Flow steps, segments, or emails with it. However, existing steps, segments, or emails that use the field will not be changed. Also, people with values already recorded for the field will still preserve the data.

Duplicate a custom field

To duplicate a field click on the three dots to the left of the field name and select Duplicate. You will be prompted to write the name of the duplicated field. Note that it's not possible to have two fields with the same name.

Move a custom field to a folder

To move a custom field to a folder, click on the three dots next to the field name and select "Move to folder". Then, select the folder and click the Move button.

Note that a custom field (or any other type of item) can only be in one folder at a time. You can later move the custom field to a different folder if you wish.