Custom fields

A custom field is a box the firm adds, such as Thesis fit on a company. Creating it here does not set a value. The value is a key on a record create or patch, using the stored name (thesis_fit).

Method	Path	What it does
GET	/api/v1/x/fields	Definitions. Optional entityType is a catalog key
POST	/api/v1/x/fields	Create a definition
PATCH	/api/v1/x/fields/{id}	Change the label, description, required flag, options, order, section, or attribute set

Any signed-in user may list definitions. Create and patch need admin.custom_fields.manage.

entityType is the catalog key. Company is stored as company. LegalEntity is stored as legal_entity. company and PortCo are 400 unknown_entity. A catalog key this screen does not store, such as Mention, is 400 invalid_field.

fieldName must match ^[a-z][a-z0-9_]{0,63}$. Spaces and capitals are rejected. It must not collide with a system field or an existing custom field on that type. tenantId, id, entityType, expectedCatalogVersion, and acknowledgeDuplicates are reserved names.

fieldType is exact: Text, Number, Decimal, Boolean, Date, DateTime, Select, MultiSelect, Url, Email, Currency, Country. Select and MultiSelect require a non-empty options array of strings. Every other type rejects options.

displayLabel is required, max 200. required defaults to false.

Create turns portal forms, filters, search, reports, analytics, and exports off. A later patch can turn a flag on. The key is not renamed. A patch body that includes fieldName is 400.

Create accepts description, required, options, and displayOrder. Patch accepts those plus sectionName and attributeSetId. attributeSetId null removes the field from its set. Creating and ordering the set itself is on Attribute sets.

{
  "entityType": "Company",
  "fieldName": "thesis_fit",
  "displayLabel": "Thesis fit",
  "fieldType": "Number"
}

After that write, thesis_fit appears on the Company entry in the catalog. A company patch can then send it.