Name | Description | Type | Additional information |
---|---|---|---|
MinValue |
Minimum value supported by the field. |
decimal number | |
MaxValue |
Maximum value supported by the field. |
decimal number | |
DecimalPlaces |
The maximum number of decimal places allowed by the field. |
integer | |
DefaultValue |
The default value of the field |
decimal number | |
FieldMask |
Stores the field's input mask definition. It will be used to drive data collection on a UI |
string |
Max length: 4000 |
Name |
The name of the field |
string |
Required Max length: 94 Min length: 1 |
LocalizedDisplayNames |
Localized display names of the field |
Collection of LocalizedDisplayName |
Required |
Description |
The description of the field |
string |
Max length: 256 |
UpdateRuleId |
Id associated with the update rule |
UpdateRules | |
DisplayOrder |
Determines the display order of the field when driving preference collection touchpoints |
integer | |
IsReadOnly |
Determines whether the field is ReadOnly or not. This property can be set via a POST when creating a Custom Field. Its value can be changed via PATCH. |
boolean |
This property is designed to assist API users to enforce read-only behavior on custom field values when driving preference collection touchpoints. The MyPreferences API does not validate against this property when updating custom field values on a profile |
IsRequired |
Determines whether the field is required or not |
boolean | |
IsActive |
Indicates the status of the field |
boolean |