Ampersand · Schema

FieldDefinition

Field definition for creating or updating custom fields

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Properties

Name Type Description
fieldName string The identifier of the field
displayName string The human-readable name of the field
description string Optional description of the field
valueType string The data type of the field. Valid values are string, boolean, date, datetime, singleSelect, multiSelect, int, float, reference
required boolean Indicates if the field is required
unique boolean Indicates if the field must be unique across all records
indexed boolean Indicates if the field should be indexed for faster search
stringOptions object
numericOptions object
association object
View JSON Schema on GitHub