> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.simplified.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.simplified.com/_mcp/server.

# Web chat · Configure the website bot

PATCH https://kd-agents.simplified.com/api/v1/webchat/agents/{agent_id}/bot
Content-Type: application/json

Everything a customer sets after publishing: which sites may embed it, how it
looks, what it asks a visitor for, whether it can fetch a colleague, and what
it may spend in a month.

**`appearance`, `lead_form` and `handover` are replaced wholesale, and
`allowed_origins` is the whole list.** Sending `{"appearance": {"title": "x"}}`
discards every other appearance field. Read the bot first and send the
complete object, including the parts that are not changing.

`status` is the live toggle — `paused` is how a bot stops answering without
the customer taking the snippet off their page, and is the reversible way to
unpublish. Switching to `active` also takes a draft agent live, because a
draft agent cannot run and the widget would otherwise report success and stay
silent.

The response's `lead_form_policy` and `lead_form_fields` are resolved from
what was stored, so read them back rather than assuming the write echoes.

Reference: https://docs.simplified.com/api-reference/agents/web-chat/update-web-chat-bot

## Authentication

- `Authorization` header (required) (prefixed with ` Api-Key   `) — Header authentication of the form `Api-Key  <token>`
- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `agent_id` (string, required) — Agent UUID or slug — both are accepted. From `agents_listAgents`.

### Body (application/json)

This endpoint expects a WebChatBotUpdate.

- `status` (enum, optional) — The live toggle. `paused` stops the bot answering while the snippet stays on the customer's page; `active` also takes a draft agent live.
  - Allowed values: `active`, `paused`
- `allowed_origins` (list of string, optional) — Sites permitted to embed the widget, as origins (`https://shop.example`). The whole list — to add one, send the existing entries alongside it. Empty allows any site that has the key. A browser-side check, not a spend control: the monthly cap is what bounds cost.
- `appearance` (WebChatAppearance, optional) — How the widget looks and what it says first. Replaced wholesale on a write, so send every field being kept.
- `lead_form` (WebChatLeadForm, optional) — What the widget asks a visitor for before the conversation. Replaced wholesale on a write.
- `handover` (WebChatBotUpdateHandover, optional) — Replaced wholesale on a write.
- `monthly_message_cap` (integer, optional, nullable) — Messages this bot may answer per calendar month. `null` is no cap; `0` answers nobody. Counted in messages, not credits.

## Response

### 200

The updated bot.

## Errors

### 400 Bad Request Error

Validation error.

- `any`

### 404 Not Found Error

This agent has no website bot, or is not in this workspace.

- `any`

## Types

### WebChatAppearance

How the widget looks and what it says first. Replaced wholesale on a write, so send every field being kept.

- `title` (string, optional) — Heading in the panel, e.g. "Ask us anything".
- `subtitle` (string, optional)
- `welcome_message` (string, optional) — The bot's opening line, before the visitor types.
- `placeholder_text` (string, optional) — Greyed-out text in the message box.
- `bot_color` (string, optional) — Accent colour as a CSS hex string, e.g. `#4F46E5`.
- `logo` (string, optional) — Image URL. The agent's avatar is used when empty.
- `watermarked` (boolean, optional) — Whether the panel carries Simplified's mark.
- `extra` (map from string to any, optional) — `kickstarter` is an array of suggested opening questions; `bot_position` places the bubble, e.g. `bottom-right`.

### WebChatLeadForm

What the widget asks a visitor for before the conversation. Replaced wholesale on a write.

- `policy` (enum, optional) — `off` asks nothing, `voluntary` lets the visitor skip it, `mandatory` asks before the bot answers.
  - Allowed values: `off`, `voluntary`, `mandatory`
- `fields` (list of WebChatLeadFormFieldsItems, optional) — The questions, in order. Omit with a policy other than `off` to take the default set — name, email and phone — rather than a form that asks nothing.

### WebChatBotUpdateHandover

Replaced wholesale on a write.

- `enabled` (boolean, optional) — Whether the bot may fetch a colleague when a visitor asks for a person. On unless set false.

### WebChatLeadFormFieldsItems

- `key` (string, required) — `name`, `email`, `phone`, or your own identifier.
- `title` (string, optional) — Label shown to the visitor.
- `placeholder` (string, optional)
- `mandatory` (boolean, optional)

## Examples

**Request**

```json
{}
```

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "https://kd-agents.simplified.com/api/v1/webchat/agents/agent_id/bot"

payload = {}
headers = {
    "Authorization": "Api-Key  <apiKey>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://kd-agents.simplified.com/api/v1/webchat/agents/agent_id/bot';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Api-Key  <apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://kd-agents.simplified.com/api/v1/webchat/agents/agent_id/bot"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Api-Key  <apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://kd-agents.simplified.com/api/v1/webchat/agents/agent_id/bot")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Api-Key  <apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://kd-agents.simplified.com/api/v1/webchat/agents/agent_id/bot")
  .header("Authorization", "Api-Key  <apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://kd-agents.simplified.com/api/v1/webchat/agents/agent_id/bot', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Api-Key  <apiKey>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://kd-agents.simplified.com/api/v1/webchat/agents/agent_id/bot");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Api-Key  <apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Api-Key  <apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://kd-agents.simplified.com/api/v1/webchat/agents/agent_id/bot")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```