User-Defined Field Definitions

---

User-Defined Field (UDF) Definitions allow you to structure and organize your User-Defined Fields. With UDF Definitions, you can set data formats, default values, and validation rules for each UDF. This ensures that the data in your UDF fields can be compatible with your ecommerce store.

UDF Definitions can be set up for Customers, Customer Addresses, Subscriptions, Group Subscriptions, and Products.

Configure a new or edit and existing UDF Definition by navigating to Environment Settings > User-Defined Field Definitions > New or Edit.

Assign UDF Definitions

You can automatically add a User-Defined Field to new Customer, Customer Address, Subscription, Group Subscription, and Product entities by selecting the Populate Default Value option. If you specify a default value, it will also be populated on new entities as they are created."

If the Don't Populate Default Value Option is selected, a definition can be added to an entity by using the exact Field Code when adding a new UDF to an inidividual entity.

The field type will be assigned and cannot be changed. If a default value exists, it will populate.

Defining Select Options

If you are using the Select field type for your User-Defined Field, you can set the list of options through the UDF Definition. Select fields must be used with the String data type. For each option, you must set a label and value. There is no limit to the number of options.

The value controls how the option will be stored and presented in the API. The label controls how the option appears in the UI.

You may select one of the options to be the default option. If you don't select a default option, then the first option will be used as the default.

User-Defined Fields Back-End Data Types

The below table lists the data types and their validation requirements. SubscribePro will only enforce these requirements if you select "true" value for the "Validate Data" setting in the UDF Definition.