Create or update web agent UI settings
curl --request POST \
--url https://api.cleartalk.ai/web-agent/{id}/web-settings \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"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>"
}
'import requests
url = "https://api.cleartalk.ai/web-agent/{id}/web-settings"
payload = {
"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>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://api.cleartalk.ai/web-agent/{id}/web-settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cleartalk.ai/web-agent/{id}/web-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cleartalk.ai/web-agent/{id}/web-settings"
payload := strings.NewReader("{\n \"button_text\": \"<string>\",\n \"button_background_color\": \"<string>\",\n \"text_color\": \"<string>\",\n \"font_size\": \"<string>\",\n \"button_hover_background_color\": \"<string>\",\n \"border_radius\": \"<string>\",\n \"show_avatar\": false,\n \"avatar_image_url\": \"<string>\",\n \"icon_color\": \"<string>\",\n \"container_background_color\": \"<string>\",\n \"base_url_for_embed\": \"<string>\",\n \"generated_iframe_url\": \"<string>\",\n \"iframe_embed_code\": \"<string>\",\n \"mobile_logo_url\": \"<string>\",\n \"mobile_brand_name\": \"<string>\",\n \"mobile_brand_tagline\": \"<string>\",\n \"mobile_logo_position\": \"<string>\",\n \"mobile_brand_name_position\": \"<string>\",\n \"mobile_background_color\": \"<string>\",\n \"mobile_gradient_start_color\": \"<string>\",\n \"mobile_gradient_end_color\": \"<string>\",\n \"mobile_text_color\": \"<string>\",\n \"mobile_secondary_text_color\": \"<string>\",\n \"mobile_answer_button_color\": \"<string>\",\n \"mobile_end_button_color\": \"<string>\",\n \"mobile_slide_bar_color\": \"<string>\",\n \"mobile_slide_bar_opacity\": \"<string>\",\n \"mobile_remember_me_icon\": \"<string>\",\n \"mobile_message_icon\": \"<string>\",\n \"mobile_phone_icon\": \"<string>\",\n \"mobile_end_call_icon\": \"<string>\",\n \"mobile_remind_me_text\": \"<string>\",\n \"mobile_message_text\": \"<string>\",\n \"mobile_slide_to_answer_text\": \"<string>\",\n \"mobile_base_url_for_embed\": \"<string>\",\n \"mobile_generated_iframe_url\": \"<string>\",\n \"mobile_iframe_embed_code\": \"<string>\",\n \"orb_button_border_radius\": \"<string>\",\n \"orb_button_size\": \"<string>\",\n \"orb_blink_color\": \"<string>\",\n \"orb_icon_color\": \"<string>\",\n \"orb_icon_size\": \"<string>\",\n \"orb_button_bg_color\": \"<string>\",\n \"orb_base_url\": \"<string>\",\n \"orb_iframe_url\": \"<string>\",\n \"orb_iframe_embed_code\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cleartalk.ai/web-agent/{id}/web-settings")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"button_text\": \"<string>\",\n \"button_background_color\": \"<string>\",\n \"text_color\": \"<string>\",\n \"font_size\": \"<string>\",\n \"button_hover_background_color\": \"<string>\",\n \"border_radius\": \"<string>\",\n \"show_avatar\": false,\n \"avatar_image_url\": \"<string>\",\n \"icon_color\": \"<string>\",\n \"container_background_color\": \"<string>\",\n \"base_url_for_embed\": \"<string>\",\n \"generated_iframe_url\": \"<string>\",\n \"iframe_embed_code\": \"<string>\",\n \"mobile_logo_url\": \"<string>\",\n \"mobile_brand_name\": \"<string>\",\n \"mobile_brand_tagline\": \"<string>\",\n \"mobile_logo_position\": \"<string>\",\n \"mobile_brand_name_position\": \"<string>\",\n \"mobile_background_color\": \"<string>\",\n \"mobile_gradient_start_color\": \"<string>\",\n \"mobile_gradient_end_color\": \"<string>\",\n \"mobile_text_color\": \"<string>\",\n \"mobile_secondary_text_color\": \"<string>\",\n \"mobile_answer_button_color\": \"<string>\",\n \"mobile_end_button_color\": \"<string>\",\n \"mobile_slide_bar_color\": \"<string>\",\n \"mobile_slide_bar_opacity\": \"<string>\",\n \"mobile_remember_me_icon\": \"<string>\",\n \"mobile_message_icon\": \"<string>\",\n \"mobile_phone_icon\": \"<string>\",\n \"mobile_end_call_icon\": \"<string>\",\n \"mobile_remind_me_text\": \"<string>\",\n \"mobile_message_text\": \"<string>\",\n \"mobile_slide_to_answer_text\": \"<string>\",\n \"mobile_base_url_for_embed\": \"<string>\",\n \"mobile_generated_iframe_url\": \"<string>\",\n \"mobile_iframe_embed_code\": \"<string>\",\n \"orb_button_border_radius\": \"<string>\",\n \"orb_button_size\": \"<string>\",\n \"orb_blink_color\": \"<string>\",\n \"orb_icon_color\": \"<string>\",\n \"orb_icon_size\": \"<string>\",\n \"orb_button_bg_color\": \"<string>\",\n \"orb_base_url\": \"<string>\",\n \"orb_iframe_url\": \"<string>\",\n \"orb_iframe_embed_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/web-agent/{id}/web-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"button_text\": \"<string>\",\n \"button_background_color\": \"<string>\",\n \"text_color\": \"<string>\",\n \"font_size\": \"<string>\",\n \"button_hover_background_color\": \"<string>\",\n \"border_radius\": \"<string>\",\n \"show_avatar\": false,\n \"avatar_image_url\": \"<string>\",\n \"icon_color\": \"<string>\",\n \"container_background_color\": \"<string>\",\n \"base_url_for_embed\": \"<string>\",\n \"generated_iframe_url\": \"<string>\",\n \"iframe_embed_code\": \"<string>\",\n \"mobile_logo_url\": \"<string>\",\n \"mobile_brand_name\": \"<string>\",\n \"mobile_brand_tagline\": \"<string>\",\n \"mobile_logo_position\": \"<string>\",\n \"mobile_brand_name_position\": \"<string>\",\n \"mobile_background_color\": \"<string>\",\n \"mobile_gradient_start_color\": \"<string>\",\n \"mobile_gradient_end_color\": \"<string>\",\n \"mobile_text_color\": \"<string>\",\n \"mobile_secondary_text_color\": \"<string>\",\n \"mobile_answer_button_color\": \"<string>\",\n \"mobile_end_button_color\": \"<string>\",\n \"mobile_slide_bar_color\": \"<string>\",\n \"mobile_slide_bar_opacity\": \"<string>\",\n \"mobile_remember_me_icon\": \"<string>\",\n \"mobile_message_icon\": \"<string>\",\n \"mobile_phone_icon\": \"<string>\",\n \"mobile_end_call_icon\": \"<string>\",\n \"mobile_remind_me_text\": \"<string>\",\n \"mobile_message_text\": \"<string>\",\n \"mobile_slide_to_answer_text\": \"<string>\",\n \"mobile_base_url_for_embed\": \"<string>\",\n \"mobile_generated_iframe_url\": \"<string>\",\n \"mobile_iframe_embed_code\": \"<string>\",\n \"orb_button_border_radius\": \"<string>\",\n \"orb_button_size\": \"<string>\",\n \"orb_blink_color\": \"<string>\",\n \"orb_icon_color\": \"<string>\",\n \"orb_icon_size\": \"<string>\",\n \"orb_button_bg_color\": \"<string>\",\n \"orb_base_url\": \"<string>\",\n \"orb_iframe_url\": \"<string>\",\n \"orb_iframe_embed_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Web agent settings created/updated successfully",
"data": {}
}Web Agent
Create or update web agent UI settings
POST
/
web-agent
/
{id}
/
web-settings
Create or update web agent UI settings
curl --request POST \
--url https://api.cleartalk.ai/web-agent/{id}/web-settings \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"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>"
}
'import requests
url = "https://api.cleartalk.ai/web-agent/{id}/web-settings"
payload = {
"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>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://api.cleartalk.ai/web-agent/{id}/web-settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cleartalk.ai/web-agent/{id}/web-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cleartalk.ai/web-agent/{id}/web-settings"
payload := strings.NewReader("{\n \"button_text\": \"<string>\",\n \"button_background_color\": \"<string>\",\n \"text_color\": \"<string>\",\n \"font_size\": \"<string>\",\n \"button_hover_background_color\": \"<string>\",\n \"border_radius\": \"<string>\",\n \"show_avatar\": false,\n \"avatar_image_url\": \"<string>\",\n \"icon_color\": \"<string>\",\n \"container_background_color\": \"<string>\",\n \"base_url_for_embed\": \"<string>\",\n \"generated_iframe_url\": \"<string>\",\n \"iframe_embed_code\": \"<string>\",\n \"mobile_logo_url\": \"<string>\",\n \"mobile_brand_name\": \"<string>\",\n \"mobile_brand_tagline\": \"<string>\",\n \"mobile_logo_position\": \"<string>\",\n \"mobile_brand_name_position\": \"<string>\",\n \"mobile_background_color\": \"<string>\",\n \"mobile_gradient_start_color\": \"<string>\",\n \"mobile_gradient_end_color\": \"<string>\",\n \"mobile_text_color\": \"<string>\",\n \"mobile_secondary_text_color\": \"<string>\",\n \"mobile_answer_button_color\": \"<string>\",\n \"mobile_end_button_color\": \"<string>\",\n \"mobile_slide_bar_color\": \"<string>\",\n \"mobile_slide_bar_opacity\": \"<string>\",\n \"mobile_remember_me_icon\": \"<string>\",\n \"mobile_message_icon\": \"<string>\",\n \"mobile_phone_icon\": \"<string>\",\n \"mobile_end_call_icon\": \"<string>\",\n \"mobile_remind_me_text\": \"<string>\",\n \"mobile_message_text\": \"<string>\",\n \"mobile_slide_to_answer_text\": \"<string>\",\n \"mobile_base_url_for_embed\": \"<string>\",\n \"mobile_generated_iframe_url\": \"<string>\",\n \"mobile_iframe_embed_code\": \"<string>\",\n \"orb_button_border_radius\": \"<string>\",\n \"orb_button_size\": \"<string>\",\n \"orb_blink_color\": \"<string>\",\n \"orb_icon_color\": \"<string>\",\n \"orb_icon_size\": \"<string>\",\n \"orb_button_bg_color\": \"<string>\",\n \"orb_base_url\": \"<string>\",\n \"orb_iframe_url\": \"<string>\",\n \"orb_iframe_embed_code\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cleartalk.ai/web-agent/{id}/web-settings")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"button_text\": \"<string>\",\n \"button_background_color\": \"<string>\",\n \"text_color\": \"<string>\",\n \"font_size\": \"<string>\",\n \"button_hover_background_color\": \"<string>\",\n \"border_radius\": \"<string>\",\n \"show_avatar\": false,\n \"avatar_image_url\": \"<string>\",\n \"icon_color\": \"<string>\",\n \"container_background_color\": \"<string>\",\n \"base_url_for_embed\": \"<string>\",\n \"generated_iframe_url\": \"<string>\",\n \"iframe_embed_code\": \"<string>\",\n \"mobile_logo_url\": \"<string>\",\n \"mobile_brand_name\": \"<string>\",\n \"mobile_brand_tagline\": \"<string>\",\n \"mobile_logo_position\": \"<string>\",\n \"mobile_brand_name_position\": \"<string>\",\n \"mobile_background_color\": \"<string>\",\n \"mobile_gradient_start_color\": \"<string>\",\n \"mobile_gradient_end_color\": \"<string>\",\n \"mobile_text_color\": \"<string>\",\n \"mobile_secondary_text_color\": \"<string>\",\n \"mobile_answer_button_color\": \"<string>\",\n \"mobile_end_button_color\": \"<string>\",\n \"mobile_slide_bar_color\": \"<string>\",\n \"mobile_slide_bar_opacity\": \"<string>\",\n \"mobile_remember_me_icon\": \"<string>\",\n \"mobile_message_icon\": \"<string>\",\n \"mobile_phone_icon\": \"<string>\",\n \"mobile_end_call_icon\": \"<string>\",\n \"mobile_remind_me_text\": \"<string>\",\n \"mobile_message_text\": \"<string>\",\n \"mobile_slide_to_answer_text\": \"<string>\",\n \"mobile_base_url_for_embed\": \"<string>\",\n \"mobile_generated_iframe_url\": \"<string>\",\n \"mobile_iframe_embed_code\": \"<string>\",\n \"orb_button_border_radius\": \"<string>\",\n \"orb_button_size\": \"<string>\",\n \"orb_blink_color\": \"<string>\",\n \"orb_icon_color\": \"<string>\",\n \"orb_icon_size\": \"<string>\",\n \"orb_button_bg_color\": \"<string>\",\n \"orb_base_url\": \"<string>\",\n \"orb_iframe_url\": \"<string>\",\n \"orb_iframe_embed_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/web-agent/{id}/web-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"button_text\": \"<string>\",\n \"button_background_color\": \"<string>\",\n \"text_color\": \"<string>\",\n \"font_size\": \"<string>\",\n \"button_hover_background_color\": \"<string>\",\n \"border_radius\": \"<string>\",\n \"show_avatar\": false,\n \"avatar_image_url\": \"<string>\",\n \"icon_color\": \"<string>\",\n \"container_background_color\": \"<string>\",\n \"base_url_for_embed\": \"<string>\",\n \"generated_iframe_url\": \"<string>\",\n \"iframe_embed_code\": \"<string>\",\n \"mobile_logo_url\": \"<string>\",\n \"mobile_brand_name\": \"<string>\",\n \"mobile_brand_tagline\": \"<string>\",\n \"mobile_logo_position\": \"<string>\",\n \"mobile_brand_name_position\": \"<string>\",\n \"mobile_background_color\": \"<string>\",\n \"mobile_gradient_start_color\": \"<string>\",\n \"mobile_gradient_end_color\": \"<string>\",\n \"mobile_text_color\": \"<string>\",\n \"mobile_secondary_text_color\": \"<string>\",\n \"mobile_answer_button_color\": \"<string>\",\n \"mobile_end_button_color\": \"<string>\",\n \"mobile_slide_bar_color\": \"<string>\",\n \"mobile_slide_bar_opacity\": \"<string>\",\n \"mobile_remember_me_icon\": \"<string>\",\n \"mobile_message_icon\": \"<string>\",\n \"mobile_phone_icon\": \"<string>\",\n \"mobile_end_call_icon\": \"<string>\",\n \"mobile_remind_me_text\": \"<string>\",\n \"mobile_message_text\": \"<string>\",\n \"mobile_slide_to_answer_text\": \"<string>\",\n \"mobile_base_url_for_embed\": \"<string>\",\n \"mobile_generated_iframe_url\": \"<string>\",\n \"mobile_iframe_embed_code\": \"<string>\",\n \"orb_button_border_radius\": \"<string>\",\n \"orb_button_size\": \"<string>\",\n \"orb_blink_color\": \"<string>\",\n \"orb_icon_color\": \"<string>\",\n \"orb_icon_size\": \"<string>\",\n \"orb_button_bg_color\": \"<string>\",\n \"orb_base_url\": \"<string>\",\n \"orb_iframe_url\": \"<string>\",\n \"orb_iframe_embed_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Web agent settings created/updated successfully",
"data": {}
}Authorizations
API Key for authentication
Path Parameters
The ID of the web agent
Body
application/json
⌘I
