object
CustomFieldDefinition
Defines a reusable custom field for either contacts or property records. Values are stored separately on each resource.
Properties
- Name
id- Type
- string
- Description
- Stable custom field definition ID.
- Name
name- Type
- string
- Description
- Human-readable label shown to teammates and API clients.
- Name
type- Type
- enum
- Description
- Value type accepted by this custom field. Allowed values: text, date.
- Name
createdAt- Type
- string
- Description
- When the field definition was created.
- Name
createdBy- Type
- string
- Description
- User ID that created the field definition.
- Name
predefined- Type
- boolean
- Description
- True for Flownally-managed fields that cannot be renamed or deleted.
- Name
entityType- Type
- enum
- Description
- Resource type this field can be used on. Allowed values: contact, property.
Related operations
- List contact field definitionsGET /contacts/custom-fields
- Create contact field definitionPOST /contacts/custom-fields
- Update contact field definitionPATCH /contacts/custom-fields/{id}
- List property field definitionsGET /properties/custom-fields
- Create property field definitionPOST /properties/custom-fields
- Update property field definitionPATCH /properties/custom-fields/{id}