Skip to main content
PUT
Update Chat Widget configuration

Overview

Update the visual customizations and settings for the Chat Widget embedded in your product. All fields are optional — only the fields you include are updated. Unspecified fields retain their current values. Requires the ORG_ADMIN or DEVELOPER role. The QA role does not have write access to widget settings.

Required Permission

agents with ORG_ADMIN or DEVELOPER role

Path Parameters

Request Body Fields

Example cURL

Response

Success (200)

Error Responses

403 Forbidden - Insufficient role
404 Not Found - Agent does not exist

Use Cases

  • Matching the chat widget to your brand colors and typography
  • Customizing the widget for different agents (e.g. support vs. sales)
  • Enabling or disabling the widget for a specific agent
  • Restricting widget access to specific domains via allowedOrigins
Use Get Chat Widget Config first to retrieve the current settings before making partial updates.
Save the requestId from every response. You will need it if you contact Inya support to trace a specific request.

Authorizations

x-api-key
string
header
required

API key with 'agents' permission

Path Parameters

botId
string
required

Unique identifier of the agent

Body

application/json
chatSdkConfig
object

Response

Chat SDK config updated successfully

status
string
Example:

"success"

requestId
string
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

message
string
response
object