| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Id of the field. |
integer |
Read-Only |
| Edited |
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified. |
EditInfo |
Read-Only |
| PicklistId |
The Id of the associated picklist |
integer |
Required Range: inclusive between 1 and 2147483647 |
| DisplayType |
Custom field's display type |
SelectListDisplayType |
Required |
| DefaultState |
The default state of the checkbox |
CheckboxStates | |
| 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 |