| name | data type | description |
|---|---|---|
| name | string | Not null. The name of the additional field as shown in the profile. Maximum length of 256 characters. |
| placeholder | string | Not null. This is in the input field, when customizing the profile if no text has been entered yet. Maximum length of 256 characters. |
| type | string | Not null. The type of content that can be entered. Allows a specific click action to be done in the app.
Note: This type cannot be changed later. Possible values: TEXT, PHONE_NUMBER,
URL, LOCATION and EMAIL.
|
| icon | ApiFontAwesomeIcon | Not null. This icon represents the field in the member profile. Font Awesome is used here. Only regular, solid and brands styles are supported. |
| isEditableByMember | boolean | Not null. Set to true if this field is customizable by the member in the app.
|
| isMandatoryForMember | boolean | Not null. Set to true if this field is required for the member to be completed.
|
| isVisibleInApp | boolean | Not null. Set to false if this field should never be visible to members in the app. Note: when this
field is set to false, it will not be possible for members to edit this field form the app.
|
| orderNumber | number | Not null. Use this value to determine the order of the fields in the app. The lower the value the higher the field is visible on the profile. When the given value is already being used by another field, the current field is given priority and the other field is pushed back. Minimum value is 0. |
Example
{
"name" : "Company name",
"placeholder" : "Your company name",
"type" : "TEXT",
"icon" : {
"style" : "REGULAR",
"unicode" : "f34e"
},
"isEditableByMember" : true,
"isMandatoryForMember" : true,
"isVisibleInApp" : true,
"orderNumber" : 0
}