update_faqs

Update one or more existing FAQ entries

Input

Parameter
Type
Required
Description

faqs

UpdateFaqInput[]

Yes

Array of FAQ entries to update - UpdateFaqInput

UpdateFaqInput

Field
Type
Required
Description

faqId

string

Yes

The ID of the FAQ to update

entityType

FaqEntityType

No

The type of entity that the FAQ is associated with - FaqEntityType

entityId

string

No

The ID of the entity (unit, unit type, or building)

type

FaqType

No

The category of the FAQ - FaqType

title

string

No

The title (question) of the FAQ

body

string

No

The body content (answer) of the FAQ

FaqEntityType

Value
Description

BUILDING

A building containing unit types and units

UNIT

A single accommodation unit (property)

UNIT_TYPE

A unit type grouping multiple units

FaqType

Value
Description

GENERAL

General FAQ visible to all audiences

GUEST

FAQ intended for guests

OPS

FAQ intended for operations staff

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