API Reference

Create a WidgetConfigurations

post
https://api.vcita.biz/v3/online_presence/widget_configurations

Creates a widget configuration for a business. Available for Staff token;

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

Widget title shown in the chat header.

string | null

Business FAQ and guidance text used by the assistant.

string | null

Business hours text shown to visitors or used for assistant guidance.

string | null

Message shown when the widget chat opens.

string | null

Hex color

string | null

Hex color

uri | null

Public logo URL shown in the widget.

actions
array of objects | null

Ordered list of configured portal actions.

actions
boolean | null

Whether the widget auto-opens for visitors.

number | null
0 to 3600

Auto-open delay in seconds.

welcome_buttons
array of objects | null

Quick-reply buttons shown under the welcome message.

welcome_buttons
string | null

Prompt text used when collecting visitor lead details.

lead_intent_data
array of objects | null

Per-intent lead-capture configuration: which fields to collect and how to message the visitor for each detected intent (max 10).

lead_intent_data
string | null

Launcher button label shown before opening the widget.

boolean | null

Whether contact information is included in assistant context.

boolean | null

Whether business services are included in assistant context.

boolean | null

Whether products are included in assistant context.

boolean | null

Whether booking policies are included in assistant context.

boolean | null

Whether terms of service are included in assistant context.

guidance_urls
array of uris | null

List of public URLs used as additional assistant guidance sources.

guidance_urls
Responses

Updated about 4 hours ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 4 hours ago