Update an AIChatConfiguration

put

https://api.vcita.biz/v3/online_presence/ai_chat_configurations

Creates or updates the AI chat configuration for the authenticated business. Provided fields are merged with existing values; omitted fields are unchanged. Available for Staff tokens.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body for upserting the AI chat configuration. All fields are optional — only provided fields are merged with existing values.

faq_and_guidance

string | null

Free-text FAQ and guidance instructions for the AI receptionist.

business_hours

string | null

Business hours text; null uses calendar-derived defaults.

lead_basic_contact_fields

string | null

enum

Contact info the AI receptionist must try to collect before creating a lead. Guidance only; the CRM still creates a lead whenever a name and at least one of phone/email are present. Null uses the default (e.g., "phone_or_email").

Allowed:

lead_fields

array of objects | null

Additional lead fields the AI receptionist should try to collect (optional, never blocking).

lead_fields

include_contact_info

boolean | null

Whether to include business contact info in AI guidance context.

include_services

boolean | null

Whether to include business services in AI guidance context.

include_products

boolean | null

Whether to include business products in AI guidance context.

include_booking_policies

boolean | null

Whether to include booking policies in AI guidance context.

include_terms_of_service

boolean | null

Whether to include terms of service in AI guidance context.

allow_chat_based_online_scheduling

boolean | null

Defaults to true

Whether the AI receptionist may complete a booking inside the chat. Independent of the business's own online-scheduling setting — both must be on for in-chat booking to run; when off, the receptionist offers a link to the booking screen instead. Defaults to true. (e.g., true, false)

guidance_urls

array of uris | null

Extra URLs whose content is merged into AI guidance.

guidance_urls

ai_actions

array of objects | null

AI proactive action behavior.

ai_actions

Responses

200AI chat configuration updated successfully.

401Unauthorized — missing or invalid token.

422Unprocessable Entity — validation error.