create_products

Create one or more products. Required fields: name, product group ID, product type (STUDENT, SHORT_STAY, or MULTI_FAMILY), rate configuration (amount in cents, currency, interval), target unit count, and unit type ID. Optional fields include target occupancy percentage.

Input

Parameter
Type
Required
Description

products

CreateProductInput[]

Yes

Array of product entries to create - CreateProductInput

CreateProductInput

Field
Type
Required
Description

name

string

Yes

The name of the product

productGroupId

string

Yes

The ID of the product group this product belongs to

productType

ProductType

Yes

The type of the product - ProductType

rate

CreateRateInput

Yes

The rate details for the product - CreateRateInput

targetUnitCount

number

Yes

The target count of units for this product

unitTypeId

string

Yes

The ID of the unit type associated with this product

targetOccupancyPercentage

number

No

The target occupancy percentage (0-100)

CreateRateInput

Field
Type
Required
Description

amountCents

number

Yes

The amount in cents for the rate

currency

string

Yes

The currency code (e.g., GBP, USD)

interval

Interval

Yes

The interval of the rate - Interval

ProductType

Value
Description

STUDENT

SHORT_STAY

MULTI_FAMILY

Interval

Value
Description

MONTHLY

WEEKLY

NIGHTLY

Output

Field
Type
Description

content

ContentItem[]

Array of content items returned by the tool - ContentItem

isError

boolean

Whether the tool execution resulted in an error

ContentItem

Field
Type
Description

type

'text'

Content type (currently only 'text' is supported)

text

string

The text content to display

Last updated