For the complete documentation index, see llms.txt. This page is also available as Markdown.

Setting up Custom Fields

The Custom Fields schema is managed in the Custom Fields module (Configuration → Custom Fields). Each supported area — Members, Direct, Referral, Automation, Leaderboards, Challenges, Rewards, and Fortune Wheels — has its own separate schema, listed by module on the main screen.

🛠️ Creating a group

1

Open a module

From Custom Fields, select the module you want to configure, e.g. Members.

2

Add a group

Click Add group and fill in the group's Name, System code, and an optional Description. The description is shown to admins wherever the group's values are displayed (e.g. on the Single Member View).

3

Add fields to the group

Click Add field and choose a type: Subgroup, String, Single select, Multi select, Number, Boolean, or Date.

4

Configure the field

Set the field's Name, System code, whether it's Required, and — for Single select / Multi select — the Collection it draws predefined values from. Save and repeat for every field the group needs.

5

Add a subgroup (Members only)

To let a member hold several rows of the same shape (e.g. multiple vehicles), click Add group → Subgroup instead of a simple field, then add the row-level fields (e.g. Plate No, VIN, Make) the same way.

Field settings

  • Name — the label shown on forms and in views.

  • System code — the technical key used in the API, imports, and exports. Upper-case characters are allowed (e.g. FeatureSubscriptionHHC), so you can keep naming consistent with an external system.

  • Required — a required field is marked with an asterisk on the entity form, and the record can't be saved without a value.

  • Predefined values — for Single select / Multi select, the Collection the values come from. See Collections.

  • Status — each field and group can be activated or deactivated independently without deleting it.

Names and system codes only need to be unique within their own group or subgroup — the same name or code can be reused in a different group or a different subgroup.

Each module tracks how many fields are currently used against its limit (shown as a counter, e.g. 9 / 25 fields used), so you can plan a schema before rolling it out.

Managing an existing schema

  • Edit a group or field to adjust its name, description, or configuration.

  • Deactivate a field or group to hide it from forms without deleting its stored data.

  • Delete a field or group using the trash icon — this permanently removes it and any values stored against it.

Last updated

Was this helpful?