Skip to main content
PATCH
/
api
/
external
/
chatbot
/
{chatbotId}
/
chat-widget
Chat Widget
curl --request PATCH \
  --url https://v2.okchat.ai/api/external/chatbot/{chatbotId}/chat-widget \
  --header 'Content-Type: application/json' \
  --data '
{
  "header": "Customer Support",
  "language": "auto",
  "logo": "https://example.com/logo.png",
  "name": "Support Assistant",
  "primaryColor": "#4F46E5",
  "secondaryColor": "#10B981",
  "slogan": "How can I help you today?"
}
'
import requests

url = "https://v2.okchat.ai/api/external/chatbot/{chatbotId}/chat-widget"

payload = {
"header": "Customer Support",
"language": "auto",
"logo": "https://example.com/logo.png",
"name": "Support Assistant",
"primaryColor": "#4F46E5",
"secondaryColor": "#10B981",
"slogan": "How can I help you today?"
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
header: 'Customer Support',
language: 'auto',
logo: 'https://example.com/logo.png',
name: 'Support Assistant',
primaryColor: '#4F46E5',
secondaryColor: '#10B981',
slogan: 'How can I help you today?'
})
};

fetch('https://v2.okchat.ai/api/external/chatbot/{chatbotId}/chat-widget', 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://v2.okchat.ai/api/external/chatbot/{chatbotId}/chat-widget",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'header' => 'Customer Support',
'language' => 'auto',
'logo' => 'https://example.com/logo.png',
'name' => 'Support Assistant',
'primaryColor' => '#4F46E5',
'secondaryColor' => '#10B981',
'slogan' => 'How can I help you today?'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$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://v2.okchat.ai/api/external/chatbot/{chatbotId}/chat-widget"

payload := strings.NewReader("{\n \"header\": \"Customer Support\",\n \"language\": \"auto\",\n \"logo\": \"https://example.com/logo.png\",\n \"name\": \"Support Assistant\",\n \"primaryColor\": \"#4F46E5\",\n \"secondaryColor\": \"#10B981\",\n \"slogan\": \"How can I help you today?\"\n}")

req, _ := http.NewRequest("PATCH", url, payload)

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.patch("https://v2.okchat.ai/api/external/chatbot/{chatbotId}/chat-widget")
.header("Content-Type", "application/json")
.body("{\n \"header\": \"Customer Support\",\n \"language\": \"auto\",\n \"logo\": \"https://example.com/logo.png\",\n \"name\": \"Support Assistant\",\n \"primaryColor\": \"#4F46E5\",\n \"secondaryColor\": \"#10B981\",\n \"slogan\": \"How can I help you today?\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://v2.okchat.ai/api/external/chatbot/{chatbotId}/chat-widget")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"header\": \"Customer Support\",\n \"language\": \"auto\",\n \"logo\": \"https://example.com/logo.png\",\n \"name\": \"Support Assistant\",\n \"primaryColor\": \"#4F46E5\",\n \"secondaryColor\": \"#10B981\",\n \"slogan\": \"How can I help you today?\"\n}"

response = http.request(request)
puts response.read_body
{
  "chat_widget_config": {
    "header": "Customer Support",
    "language": "auto",
    "logo": "https://example.com/logo.png",
    "name": "Support Assistant",
    "primaryColor": "#4F46E5",
    "secondaryColor": "#10B981",
    "slogan": "How can I help you today?"
  },
  "message": "Chat widget config updated successfully"
}

Headers

x-api-key
string
Example:

"15a23c21867f4f38b0b46f5e4adb1caf87a040b34eb58f68"

Path Parameters

chatbotId
string
required
Example:

"3317853e-0af2-427d-a56f-351a9587f48f"

Body

application/json
header
string
Example:

"Customer Support"

language
string
Example:

"auto"

Example:

"https://example.com/logo.png"

name
string
Example:

"Support Assistant"

primaryColor
string
Example:

"#4F46E5"

secondaryColor
string
Example:

"#10B981"

slogan
string
Example:

"How can I help you today?"

Response

200 - application/json

Example

chat_widget_config
object
message
string
Example:

"Chat widget config updated successfully"