> This page is for API Reference & Tools.

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

# Update embedded assistant settings

PATCH https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting
Content-Type: application/json

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus `version` with the `num` from your last read and a `change_description`. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole.

Reference: https://docs.moveworks.com/api-reference/configuration-api/platform-org/embedded-assistant-settings/update-embedded-assistant-settings

## Authentication

- `Authorization` header (bearer token, required) — JWT bearer token authentication. Include the Configuration API key in the Authorization header as 'Bearer \<token>'.

## Request

### Body (application/json)

This endpoint expects an EmbeddedAssistantSettingConfigPatch.

- `version` (EmbeddedAssistantSettingVersionPatch, required) — Document version. On update, send back the num from your last read.
- `font_family` (string, optional) — Custom font family for the chat, in CSS font-family syntax. Invalid values are ignored and the default font is used.
- `avatar_button` (AvatarButtonSettings, optional) — Settings for the assistant avatar button.
- `close_button` (CloseButtonSettings, optional) — Settings for the chat close button.
- `speech_bubble` (SpeechBubbleSettings, optional) — Controls how the speech bubble above the avatar is displayed.
- `full_screen_height` (string, optional) — Height of the full screen chat window, in CSS syntax. Invalid values are ignored and the default of 100% is used.
- `full_screen_width` (string, optional) — Width of the full screen chat window, in CSS syntax. Invalid values are ignored and the default of 100% is used.
- `display_urls` (UrlFilterSettings, optional) — Wildcard URL patterns that decide on which pages the assistant is displayed.
- `proactive_popup_urls` (UrlFilterSettings, optional) — Wildcard URL patterns that decide on which pages the chat opens automatically.

## Response

### 200

The updated embedded assistant settings, at its new version

- `font_family` (string, optional) — Custom font family for the chat, in CSS font-family syntax. Invalid values are ignored and the default font is used.
- `avatar_button` (AvatarButtonSettings, optional) — Settings for the assistant avatar button.
- `close_button` (CloseButtonSettings, optional) — Settings for the chat close button.
- `speech_bubble` (SpeechBubbleSettings, optional) — Controls how the speech bubble above the avatar is displayed.
- `full_screen_height` (string, optional) — Height of the full screen chat window, in CSS syntax. Invalid values are ignored and the default of 100% is used.
- `full_screen_width` (string, optional) — Width of the full screen chat window, in CSS syntax. Invalid values are ignored and the default of 100% is used.
- `display_urls` (UrlFilterSettings, optional) — Wildcard URL patterns that decide on which pages the assistant is displayed.
- `proactive_popup_urls` (UrlFilterSettings, optional) — Wildcard URL patterns that decide on which pages the chat opens automatically.
- `updated_time` (datetime, optional) — When the configuration was last updated.
- `updated_by` (string, optional) — Who last updated the configuration.
- `version` (Version, optional) — Document version. On update, send back the num from your last read.

## Errors

### 400 Bad Request Error

Bad request - the body breaks a rule in the schema (a missing required field, an unknown enum value, an invalid DSL or Data Mapper expression), `version.change_description` is missing, or an id in the body doesn't match the URL

- `error` (ErrorResponseError, required)

### 401 Unauthorized Error

Unauthorized - the `Authorization` header is missing or the token is invalid

- `error` (ErrorResponseError, required)

### 403 Forbidden Error

Forbidden - the API key isn't allowed to change this configuration, or the configuration is frozen for your organization

- `error` (ErrorResponseError, required)

### 409 Conflict Error

Conflict - `version.num` doesn't match the stored version (someone changed it since your last read; read it again and retry), or the item already exists

- `error` (ErrorResponseError, required)

### 429 Too Many Requests Error

Too many requests - the organization exceeded the Configuration API rate limit. Back off and retry.

- `error` (ErrorResponseError, required)

### 500 Internal Server Error

Internal server error - retry the request

- `error` (ErrorResponseError, required)

## Types

### EmbeddedAssistantSettingVersionPatch

- `change_description` (string, required) — A short note describing this change. Required on every create and update.
- `num` (integer, optional) — Version number set by the server. On update, send the num from your last read; a stale num is rejected as a conflict.

### AvatarButtonSettings

- `image_url` (string, optional) — URL of a publicly accessible image for the assistant avatar. If blank, the default Moveworks logo is used.
- `size` (integer, optional) — Height and width of the avatar, in pixels.

### CloseButtonSettings

- `size` (integer, optional) — Height and width of the close button, in pixels.

### SpeechBubbleSettings

- `hide_after_expiration_enabled` (boolean, optional) — If true, the speech bubble above the avatar hides after expiration_time_seconds. If false, it disappears after the first click.
- `expiration_time_seconds` (integer, optional) — How long the speech bubble is shown, in seconds.

### UrlFilterSettings

- `allow_list` (list of string, optional) — Wildcard URL patterns where the behavior applies. Each must start with http:// or https:// and be unique.
- `block_list` (list of string, optional) — Wildcard URL patterns where the behavior does not apply. Each must start with http:// or https:// and be unique.

### Version

- `num` (integer, optional) — Version number set by the server. On update, send the num from your last read; a stale num is rejected as a conflict.
- `change_description` (string, optional) — A short note describing this change. Required on every create and update.

### ErrorResponseError

- `code` (string, optional) — A machine-readable error code.
- `message` (string, optional) — What went wrong, and for a rejected field, which rule it broke.

## Examples

### Embedded Assistant Settings endpoints_updateEmbeddedAssistantSettings_example

**Response**

```json
{
  "font_family": "<string>",
  "avatar_button": {
    "image_url": "https://example.com/path",
    "size": 1
  },
  "close_button": {
    "size": 1
  },
  "speech_bubble": {
    "hide_after_expiration_enabled": true,
    "expiration_time_seconds": 60
  },
  "full_screen_height": "<string>",
  "full_screen_width": "<id>",
  "display_urls": {
    "allow_list": [
      "https://example.com"
    ],
    "block_list": [
      "https://example.com"
    ]
  },
  "proactive_popup_urls": {
    "allow_list": [
      "https://example.com"
    ],
    "block_list": [
      "https://example.com"
    ]
  },
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 3,
    "change_description": "Update via the Configuration API"
  }
}
```

**SDK Code**

```python Embedded Assistant Settings endpoints_updateEmbeddedAssistantSettings_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript Embedded Assistant Settings endpoints_updateEmbeddedAssistantSettings_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting';
const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

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

```go Embedded Assistant Settings endpoints_updateEmbeddedAssistantSettings_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

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

}
```

```ruby Embedded Assistant Settings endpoints_updateEmbeddedAssistantSettings_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java Embedded Assistant Settings endpoints_updateEmbeddedAssistantSettings_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Embedded Assistant Settings endpoints_updateEmbeddedAssistantSettings_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp Embedded Assistant Settings endpoints_updateEmbeddedAssistantSettings_example
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Embedded Assistant Settings endpoints_updateEmbeddedAssistantSettings_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers

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()
```

### Change one field of the embedded assistant settings

**Request**

```json
{
  "version": {
    "change_description": "Update via the Configuration API",
    "num": 2
  },
  "font_family": "<string>"
}
```

**Response**

```json
{
  "font_family": "<string>",
  "avatar_button": {
    "image_url": "https://example.com/path",
    "size": 1
  },
  "close_button": {
    "size": 1
  },
  "speech_bubble": {
    "hide_after_expiration_enabled": true,
    "expiration_time_seconds": 60
  },
  "full_screen_height": "<string>",
  "full_screen_width": "<id>",
  "display_urls": {
    "allow_list": [
      "https://example.com"
    ],
    "block_list": [
      "https://example.com"
    ]
  },
  "proactive_popup_urls": {
    "allow_list": [
      "https://example.com"
    ],
    "block_list": [
      "https://example.com"
    ]
  },
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 3,
    "change_description": "Update via the Configuration API"
  }
}
```

**SDK Code**

```python Change one field of the embedded assistant settings
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting"

payload = {
    "version": {
        "change_description": "Update via the Configuration API",
        "num": 2
    },
    "font_family": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Change one field of the embedded assistant settings
const url = 'https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"version":{"change_description":"Update via the Configuration API","num":2},"font_family":"<string>"}'
};

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

```go Change one field of the embedded assistant settings
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting"

	payload := strings.NewReader("{\n  \"version\": {\n    \"change_description\": \"Update via the Configuration API\",\n    \"num\": 2\n  },\n  \"font_family\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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 Change one field of the embedded assistant settings
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"version\": {\n    \"change_description\": \"Update via the Configuration API\",\n    \"num\": 2\n  },\n  \"font_family\": \"<string>\"\n}"

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

```java Change one field of the embedded assistant settings
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"version\": {\n    \"change_description\": \"Update via the Configuration API\",\n    \"num\": 2\n  },\n  \"font_family\": \"<string>\"\n}")
  .asString();
```

```php Change one field of the embedded assistant settings
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting', [
  'body' => '{
  "version": {
    "change_description": "Update via the Configuration API",
    "num": 2
  },
  "font_family": "<string>"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Change one field of the embedded assistant settings
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"version\": {\n    \"change_description\": \"Update via the Configuration API\",\n    \"num\": 2\n  },\n  \"font_family\": \"<string>\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Change one field of the embedded assistant settings
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "version": [
    "change_description": "Update via the Configuration API",
    "num": 2
  ],
  "font_family": "<string>"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/assistant/embedded-assistant-setting")! 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()
```