> 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.

# Embedded Assistant Settings

> Read and update Embedded Assistant Settings through the Moveworks Configuration API: endpoints, fields and examples.

`assistant.embedded-assistant-setting`

Appearance/behaviour of the embedded (web) assistant widget.

* **Endpoint:** `/assistant/embedded-assistant-setting`  |  **Methods:** GET, PATCH
* **Request shape:** one per organization, so there is no `id`. It already exists: read it with `GET`, then `PATCH` the fields you want to change. Fields go at the top level of the JSON body, with no `resource` wrapper.
* **Updates:** a JSON merge-patch. Send only the fields you change, plus `version: {num, change_description}` with the `num` from your last read. Lists and maps you send replace the stored ones whole.

### Endpoints

All paths are relative to `https://api.moveworks.ai/configurations/v1alpha1`. Each endpoint page lists the request and response schema, an example, and the errors it can return.

| Method  | Path                                    | Endpoint reference                                                                                                                                 |
| ------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `GET`   | `/assistant/embedded-assistant-setting` | [Get embedded assistant settings](/api-reference/configuration-api/platform-org/embedded-assistant-settings/get-embedded-assistant-settings)       |
| `PATCH` | `/assistant/embedded-assistant-setting` | [Update embedded assistant settings](/api-reference/configuration-api/platform-org/embedded-assistant-settings/update-embedded-assistant-settings) |

### Fields

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

### Document fields (example)

The document as `GET` returns it. To change any of these, send only the fields you want to change in the `PATCH` body.

```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"
    ]
  }
}
```