Chat Settings Object


Properties
idstringRead-onlyformat GUID

The ID of the chat settings. The chat settings specified in this object apply to the form with a matching ID.


greetingMessagestringmaxLength 50

Custom greeting message displayed when a visitor opens the AI chat.


chatEnabledboolean

Whether AI chat is enabled for this form.

Default: true


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the chat settings are updated. To prevent conflicting changes, the current revision must be passed when updating the chat settings.


createdDatestringRead-onlyformat date-time

Date and time the chat settings were created.


updatedDatestringRead-onlyformat date-time

Date and time the chat settings were last updated.


summaryMessagestringmaxLength 255

Message that summarizes the contents of the form. Appears after the greeting message.


extendedFieldsExtendedFields

Extended fields.


manualSummaryboolean

Whether the summary message is manually set or AI-generated. When false the summary message is automatically generated by AI when the chat settings are saved. When true, the summary message can be manually set and won't be overwritten by AI.

Default: false

Did this help?