Get Contact Custom Field Definition
Get Custom Field Definition
POST [PlatformAddress]/api/1.0/contact?action=getCustomFieldDefinition
Get the definition of custom field
Returns
An array of objects with the following properties
| Property | Description |
|---|---|
fieldId | The unique identifier for this custom field |
fieldType | |
displayName | The name of this field |
isRequired | If this field is required or not |
isActive | If this field is active or not |
sortOrder | Order to display this field |
selectValues | Values that can be selected with select fields |
fileTypes | Types of files that can be uploaded with the file custom field |
Types of field
0 = Small Text
1 = Large Text
2 = Single Select
Valid options are provided in the ‘selectValues’ key
3 = Multiple Select
Valid options are provided in the ‘selectValues’ key
4 = Address
5 = Date
6 = File
Valid file types are provided in the ‘fileTypes’ key
7 = Static Text
Values cannot be set for this type
8 = Whole Number
This call will return an array of custom fields available on the account. The result will have the fieldId which is the unique field identifier for the specific field, as well as the display name and any options required for each field.
As part of the field definition there is a ‘fieldType’ property which can be resolved to the following types
0 = Small Text
1 = Large Text
2 = Single Select
Valid options are provided in the ‘selectValues’ key
3 = Multiple Select
Valid options are provided in the ‘selectValues’ key
4 = Address
5 = Date
6 = File
Valid file types are provided in the ‘fileTypes’ key
7 = Static Text
Values cannot be set for this type
8 = Whole Number
Last updated