API Docs / Schemas / CreateCustomFieldDefinitionRequest

CreateCustomFieldDefinitionRequest

Properties

Name Type Description
labelstring
entityTypeenum

Client

Client

dataTypeenum

Text Number Date Boolean Select MultiSelect TextArea Address Email

Text Number Date Boolean Select MultiSelect TextArea Address Email

optionsarray of string
maxLengthinteger
linesinteger
displayWidthenum

Small Medium Large Full

Small Medium Large Full

booleanDisplayModeenum

Toggle Checkbox YesNo

Toggle Checkbox YesNo

clientTypesarray of enum

The types of clients this custom field is applicable to.
An empty list means the field is applicable to all client types.

PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader

The types of clients this custom field is applicable to.
An empty list means the field is applicable to all client types.

PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader

customFieldGroupCodestring
sortOrderinteger

JSON Example

{
  "label": "string",
  "entityType": "Client",
  "dataType": "Text",
  "options": [
    "string"
  ],
  "maxLength": 0
}

Used By Operations