Update one or more media items. Supports changing name (public caption), group, and tags. Only include the fields you
want to change per item. All items must belong to the entity identified by entityType and entityId.
| Parameter |
Type |
Required |
Description |
entityType |
EntityType |
Yes |
The type of entity the media items belong to. BUILDING for a building, UNIT for a unit (property), UNIT_TYPE for a unit type (multi-unit group). - EntityType |
entityId |
string |
Yes |
The ID of the entity the media items belong to |
items |
UpdateMediaItem[] |
Yes |
Array of media items to update. Each item must include an id and at least one field to change (name, group, or tags). All items must belong to the entity identified by entityType and entityId. - UpdateMediaItem |
| Field |
Type |
Required |
Description |
id |
string |
Yes |
The ID of the media item to update |
name |
string |
No |
Display name / public caption for the media item. Only include to change it. |
group |
Group |
No |
Move the media item to a different group: PROFESSIONAL, ONBOARDING, or MAINTENANCE. Only include to change it. - Group |
tags |
string[] |
No |
Replace the tags on this media item. Pass an empty array to remove all tags. Omit to leave tags unchanged. |
| Value |
Description |
BUILDING |
A building containing unit types and units |
UNIT |
A single accommodation unit |
UNIT_TYPE |
A unit type grouping multiple units |
| Value |
Description |
PROFESSIONAL |
Professionally produced media (e.g. listing photography) |
ONBOARDING |
Media captured during onboarding the entity |
MAINTENANCE |
Media captured for maintenance records |
| 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 |