Skip to main content
PUT
/
web-agent
/
{id}
/
settings
Update web agent settings
curl --request PUT \
  --url https://api.cleartalk.ai/web-agent/{id}/settings \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "phoneNumber": "+1234567890",
  "max_duration": 300,
  "temperature": 0.7,
  "voiceSpeed": 1,
  "similarity": 0.75,
  "stability": 0.5,
  "background_track": "background_music.mp3",
  "interruptionThreshold": 1000,
  "calendarID": "cal_123456",
  "calendarName": "Business Hours",
  "pathwayID": "path_123456",
  "customTool": [],
  "inboundCustomTool": [],
  "waitForGreeting": true,
  "questionsData": [
    {
      "question": "What is your name?",
      "questionType": "text"
    }
  ],
  "appointmentAgent": true,
  "task": "Handle customer inquiries",
  "knowledgeName": "customer_support",
  "transferPhoneNumber": "+1987654321",
  "selectedVoice": "Maya",
  "model": "enhanced",
  "firstSentence": "Hello, how can I help you today?",
  "selectedLanguage": "en",
  "agentName": "Customer Support Agent",
  "store": true,
  "webSettings": {
    "button_text": "<string>",
    "button_background_color": "<string>",
    "text_color": "<string>",
    "font_size": "<string>",
    "button_hover_background_color": "<string>",
    "border_radius": "<string>",
    "show_avatar": false,
    "avatar_image_url": "<string>",
    "icon_color": "<string>",
    "container_background_color": "<string>",
    "base_url_for_embed": "<string>",
    "generated_iframe_url": "<string>",
    "iframe_embed_code": "<string>",
    "mobile_logo_url": "<string>",
    "mobile_brand_name": "<string>",
    "mobile_brand_tagline": "<string>",
    "mobile_logo_position": "<string>",
    "mobile_brand_name_position": "<string>",
    "mobile_background_color": "<string>",
    "mobile_gradient_start_color": "<string>",
    "mobile_gradient_end_color": "<string>",
    "mobile_text_color": "<string>",
    "mobile_secondary_text_color": "<string>",
    "mobile_answer_button_color": "<string>",
    "mobile_end_button_color": "<string>",
    "mobile_slide_bar_color": "<string>",
    "mobile_slide_bar_opacity": "<string>",
    "mobile_remember_me_icon": "<string>",
    "mobile_message_icon": "<string>",
    "mobile_phone_icon": "<string>",
    "mobile_end_call_icon": "<string>",
    "mobile_remind_me_text": "<string>",
    "mobile_message_text": "<string>",
    "mobile_slide_to_answer_text": "<string>",
    "mobile_base_url_for_embed": "<string>",
    "mobile_generated_iframe_url": "<string>",
    "mobile_iframe_embed_code": "<string>",
    "orb_button_border_radius": "<string>",
    "orb_button_size": "<string>",
    "orb_blink_color": "<string>",
    "orb_icon_color": "<string>",
    "orb_icon_size": "<string>",
    "orb_button_bg_color": "<string>",
    "orb_base_url": "<string>",
    "orb_iframe_url": "<string>",
    "orb_iframe_embed_code": "<string>"
  }
}
'
{
  "status": "success",
  "message": "Agent updated successfully",
  "agent_id": "agent_123456"
}

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Path Parameters

​
id
string
required

The ID of the web agent to update

Body

application/json
​
phoneNumber
string
required

Phone number for the agent

Example:

"+1234567890"

​
max_duration
number
required

Maximum duration for the agent in seconds

Example:

300

​
temperature
number
required

Temperature setting for the agent

Example:

0.7

​
voiceSpeed
number
required

Voice speed setting

Example:

1

​
similarity
number
required

Similarity setting for voice

Example:

0.75

​
stability
number
required

Stability setting for voice

Example:

0.5

​
background_track
string
required

Background track for the agent

Example:

"background_music.mp3"

​
interruptionThreshold
number
required

Interruption threshold in milliseconds

Example:

1000

​
calendarID
string
required

Calendar ID for appointments

Example:

"cal_123456"

​
calendarName
string
required

Calendar name

Example:

"Business Hours"

​
pathwayID
string
required

Pathway ID

Example:

"path_123456"

​
customTool
string[]
required

Custom tools metadata

Example:
[]
​
inboundCustomTool
string[]
required

Inbound custom tools

Example:
[]
​
waitForGreeting
boolean
required

Wait for greeting setting

Example:

true

​
questionsData
string[]
required

Agent questions data

Example:
[
  {
    "question": "What is your name?",
    "questionType": "text"
  }
]
​
appointmentAgent
boolean
required

Appointment agent setting

Example:

true

​
task
string
required

Task description

Example:

"Handle customer inquiries"

​
knowledgeName
string
required

Knowledge base name

Example:

"customer_support"

​
transferPhoneNumber
string
required

Transfer phone number

Example:

"+1987654321"

​
selectedVoice
string
required

Selected voice

Example:

"Maya"

​
model
string
required

AI model to use

Example:

"enhanced"

​
firstSentence
string
required

First sentence for the agent

Example:

"Hello, how can I help you today?"

​
selectedLanguage
string
required

Selected language

Example:

"en"

​
agentName
string
required

Agent name

Example:

"Customer Support Agent"

​
store
boolean
required

Store setting

Example:

true

​
webSettings
object

Web agent settings

Response

The web agent settings have been successfully updated

​
status
string
Example:

"success"

​
message
string
Example:

"Agent updated successfully"

​
agent_id
string
Example:

"agent_123456"