> 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 · Publish the agent to a website

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

Publishes the agent as a website bot and returns it, including the
`widget_key` and the `embed_snippet` to paste. The bot is created answering,
and a draft agent is taken live along with it.

Safe to repeat: publishing an agent that already has a bot returns that same
bot, with the same `widget_key`, and changes nothing. The key goes into the
customer's page source, so it is never rotated here.

This publishes; it does not configure. A body is optional and applies only on
the first call — on a bot that already exists, settings are left alone. Send
configuration as a `PATCH` to this same path rather than relying on this body.

Until an origin is allowed the widget answers any site that embeds the key,
so set `allowed_origins` as part of publishing rather than afterwards.


Reference: https://docs.simplified.com/api-reference/agents/web-chat/publish-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 WebChatBotPublish.

- `allowed_origins` (list of string, optional) — Sites permitted to embed the widget, as origins (`https://shop.example`). Empty allows any site that has the key.
- `appearance` (WebChatAppearance, optional) — How the widget looks and what it says first. Replaced wholesale on a write, so send every field being kept.

## Response

### 200

Already published; the existing bot, unchanged.

### 201

Published.

## Errors

### 404 Not Found Error

No such agent 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`.

## Examples

### Example 1

**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.put(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: 'PUT',
  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("PUT", 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::Put.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.put("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('PUT', '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.PUT);
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 = "PUT"
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()
```

### Example 2

**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.put(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: 'PUT',
  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("PUT", 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::Put.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.put("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('PUT', '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.PUT);
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 = "PUT"
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()
```