Skip to content

set_amenities

Set amenities for an entity (unit, unit type, or building). Replaces all existing amenities with the provided list. Pass an empty array to remove all amenities.

Parameter Type Required Description
entityType EntityType Yes The type of entity to manage amenities for - EntityType
entityId string Yes The ID of the entity
amenityIds string[] Yes Array of amenity IDs to set on the entity. Pass an empty array to remove all amenities.
Value Description
UNIT A single accommodation unit
UNIT_TYPE A unit type grouping multiple units
BUILDING A building containing unit types and units
Field Type Description
content ContentItem[] Array of content items returned by the tool - ContentItem
isError boolean Whether the tool execution resulted in an error
Field Type Description
type 'text' Content type (currently only ‘text’ is supported)
text string The text content to display