Create one or more copies of an existing unit. Each section listed in copy is cloned from the source; sections you
omit are initialised with workspace defaults (or, for the calendar, a fresh schedule).
The copies are complete and safe to update as soon as the tool returns. Their default availability and calendar are
built in the background by the availability domain, from the spaces.unit.created event each copy publishes, which
also refreshes the unit type and its inventory on the OTAs once.
| Parameter |
Type |
Required |
Description |
unitId |
string |
Yes |
The ID of the unit to duplicate |
quantity |
number |
Yes |
Number of copies to create. Maximum 50. |
copy |
DuplicateUnitSection[] |
Yes |
Section names to copy from the source unit. Pass “AVAILABILITY” to copy the source’s default-availability settings and its manual closures/blocks; pass “DEFAULT_AVAILABILITY” to copy only the default-availability settings. Omit both to start the new unit with a fresh calendar. Price, minimum stay, policies and fees always come from the unit type, so there is nothing per unit to copy for them. - DuplicateUnitSection |
| Value |
Description |
CONFIGURATION |
Property type, bedroom/bathroom counts, max occupants, address, rooms and beds. |
MARKETING_DETAILS |
Marketing title, marketing description, location description (and translations). |
ACCOUNTS_AND_FINANCIALS |
Owners, VAT code, payout template. |
AMENITIES_AND_FEATURES |
Amenities and features at unit and room level. |
PRO_PHOTOS |
Professional media items (photos). |
PROCEDURES |
All operational procedures. |
AVAILABILITY |
Default-availability settings plus every manual closure/block on the source calendar. Prices and minimum stay are not copied: both come from the unit type. |
DEFAULT_AVAILABILITY |
Default-availability settings record only; does not copy calendar blocks. |
| 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 |