An attribute definition is a typed custom property (string, number, or boolean) that can be applied to entities. Each definition has a display name shown to end users, a value type, optional type-specific configuration (such as a list of allowed string values), and a default value.
Attribute definitions are defined once per site. To set a value for a specific entity, call Bulk Upsert Attribute Values; to read an entity's values together with their definitions, call List Entity Attributes.
Number configuration: the valid integer range.
String configuration: the list of allowed string values.
Date and time the attribute definition was created.
Default value for the attribute. When a configuration change leaves a stored attribute value out of range or outside the allowed values, that value is reset to this default (see Update Attribute Definition).
The variant must match valueType. Required when creating an attribute definition.
Custom field data for the attribute definition. Extended fields must be configured in the app dashboard before they can be accessed with API calls.
Attribute definition ID.
Display name for the attribute, shown to end users (for example, Capacity).
Must be unique within the site. Required when creating an attribute definition.
Revision number, which increments by 1 each time the attribute definition is updated. To prevent conflicting changes, the current revision must be passed when updating. Ignored when creating an attribute definition.
Custom tags for organizing and filtering attribute definitions.
Manage tags using BulkUpdateAttributeDefinitionTags or BulkUpdateAttributeDefinitionTagsByFilter.
Date and time the attribute definition was last updated.
Whether this attribute is shown to end users on the public site.
true: shown in the UI and available for filtering.false: hidden from end users. Back-office admins can still see and edit the attribute.Default: true.