scope

STRING

The entity for which the custom field will be applicable. For example, the custom fields created for the scope LOYALTY_REGISTRATION will be applicable only for the LOYALTY_REGISTRATION entity. Supported values are:

• LOYALTY_REGISTRATION
• LOYALTY_TRANSACTION
• CUSTOMER_FEEDBACK
• POINTS_REDEMPTION
• VOUCHER_REDEMPTION
• ZONE_CUSTOM_FIELDS
• STORE_CUSTOM_FIELDS
• CUSTOM_FIELDS_DATA_LOG
• CHECK_IN_FEEDBACK
• CUSTOMER_PREFERENCES
• ADVANCE_FEEDBACK
• LOYALTY_LINE_ITEMS
• NI_CUSTOM_FIELDS - Not in use.
• CUSTOMER_CARD
• TILL_CUSTOM_FIELDS
• ORG_CUSTOM_FIELD: Applicable for the entire org.

customFields

ARRAY

Includes the custom fields that need to be created.

• name

STRING

Name of the custom field. The maximum number of characters supported is 20.

• type

STRING

Field type of the custom field. The supported types are text, textarea, select, checkbox, radio, file, template_area, datepicker, separator, button, email_body, feedback, and label

• dataType

Enum

Data type of the custom field. The supported data types are Boolean, Integer, Double and String.

• label

STRING

Name to be displayed on the UI.

• defaultValue

STRING

Default value assigned to the custom field, e.g., "#1234". This value is only Meta data and is not tagged to entity by default. **Note: **This field applies to client-side applications like Instore and does not undergo any server-side validation.

• phase

STRING/INT

This is applicable for Instore and is not in use.

• position

INT

Specify the sequence order of the custom field. For example, 1 to appear in the first position of the form. This field applies to client-side applications like Instore and does not undergo any server-side validation.

• rule

STRING

Allows you to specify logical expressions in the Infix expression language. You can use placeholders like {{custom_field_name}}, which will be dynamically replaced with actual values during evaluation.

• serverRule

STRING

Allows you to define rules in Infix form. You should use the following format to specify the rule:
{"name":"{{custom_field_name}}","value":"{{custom_field_value}}"}
In this format, {{custom_field_name}} serves as a placeholder for the field's name, while {{custom_field_value}} represents the corresponding value. These placeholders will be dynamically replaced with actual values during evaluation, enabling flexible and context-specific rule processing.

• regex

STRING

Regular expression for validation (if any). For example, you can use regex to validate an email field.

• error

STRING

Error message to display for invalid input (if any).

• isDisabled

BOOLEAN

Indicates if the custom field is disabled (0 for false). This field applies to client-side applications like Instore and does not undergo any server-side validation.

• isCompulsory

BOOLEAN

Indicates if the custom field is mandatory (0 for false). This field applies to client-side applications like Instore and does not undergo any server-side validation.

• disableAtServer

BOOLEAN

Indicates if the field is disabled on the server (0 for false).

• isUpdatable

BOOLEAN

Indicates if the field can be updated (0 for false). This field applies to client-side applications like Instore and does not undergo any server-side validation.

• enableAuditTrail

BOOLEAN

Specifies if audit trails are enabled (0 for false).

• isPiiData

BOOLEAN

Marks if the field contains PII data (0 for false).

• isPsiData

BOOLEAN

Marks if the field contains PSI data (0 for false).

• helptext

STRING

Help text associated with the field (if any).

• attrs

STRING

Additional attributes for the field (if any).