PATCH
/
api
/
v1
/
widget-settings
/
{id}
curl -X PATCH https://api.ravan.ai/api/v1/widget-settings/019d1fdb-6701-762d-97bd-93fc72606d7c/ \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "bot_name": "Updated Support Bot",
    "language": "es"
  }'

{
  "success": true,
  "message": "Widget settings updated successfully",
  "data": {
    "id": "019d1fdb-6701-762d-97bd-93fc72606d7c",
    "botName": "Updated Support Bot",
    "botAutoStart": false,
    "botPosition": "bottom-right",
    "customFormFields": null,
    "theme": null,
    "language": "es",
    "isActive": true,
    "createdAt": "2026-03-20T10:30:00Z",
    "updatedAt": "2026-03-20T16:00:00Z"
  }
}
This is a partial update (PATCH). Only include the fields you want to modify in the request body.

​
Authorizations

​
X-Api-Key
string
required
Your Agni API key. Find it in your support@ravan.ai under Settings → API Keys.

​
Path Parameters

​
id
string
required
The unique UUID of the widget settings to update.

​
Body

​
bot_name
string
Display name of the bot.
​
bot_auto_start
boolean
Whether the widget auto-starts on page load.
​
bot_position
string
Widget position. Values: BOT_POSITION_BOTTOM_RIGHT, BOT_POSITION_BOTTOM_LEFT, BOT_POSITION_TOP_RIGHT, BOT_POSITION_TOP_LEFT.
URL of the bot avatar image.
Inline SVG markup for the widget button.
​
custom_form_fields
object
Custom form field configuration.
​
theme
object
Widget theme and styling configuration.
​
language
string
Language code (e.g. en, es).
​
consent_content
string
Consent modal body text.
​
consent_title
string
Consent modal title.

​
Response

​
success
boolean
Whether the request succeeded.
​
message
string
Human-readable status message.
​
data
object
The updated widget settings object.
curl -X PATCH https://api.ravan.ai/api/v1/widget-settings/019d1fdb-6701-762d-97bd-93fc72606d7c/ \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "bot_name": "Updated Support Bot",
    "language": "es"
  }'

{
  "success": true,
  "message": "Widget settings updated successfully",
  "data": {
    "id": "019d1fdb-6701-762d-97bd-93fc72606d7c",
    "botName": "Updated Support Bot",
    "botAutoStart": false,
    "botPosition": "bottom-right",
    "customFormFields": null,
    "theme": null,
    "language": "es",
    "isActive": true,
    "createdAt": "2026-03-20T10:30:00Z",
    "updatedAt": "2026-03-20T16:00:00Z"
  }
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
id
string
required

Widget Settings ID

Body

application/json
​
bot_name
string
​
bot_auto_start
boolean
​
bot_position
enum<string>

Position of the bot widget on screen

Available options:
BOT_POSITION_UNSPECIFIED,
BOT_POSITION_BOTTOM_RIGHT,
BOT_POSITION_BOTTOM_LEFT,
BOT_POSITION_TOP_RIGHT,
BOT_POSITION_TOP_LEFT
​
custom_form_fields
object
​
theme
object
​
language
string
​
consent_content
string
​
consent_title
string

Response

Successful response

​
success
boolean
​
message
string
​
data
object