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

# Display

> Read and update Display through the Moveworks Configuration API: endpoints, fields and examples.

`assistant.display`

Assistant display strings, incl. the REQUIRED handoff label maps. Maps replace wholesale: a PATCH carrying a map must list every key it wants to keep.

* **Endpoint:** `/assistant/display`  |  **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/display` | [Get display settings](/api-reference/configuration-api/handoff-live-agent/display/get-display-settings)       |
| `PATCH` | `/assistant/display` | [Update display settings](/api-reference/configuration-api/handoff-live-agent/display/update-display-settings) |

### Fields

| Field                               | Type    | Required  | Notes                                                                                                                                              |
| ----------------------------------- | ------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bot_friendly_name`                 | string  |           | Name the assistant uses to refer to itself. Other fields can reference it with \{\{ bot_friendly_name }}.                                          |
| `handoff_category_names`            | object  |           | Display titles for handoff categories, keyed by category key. Each key must match a configured handoff category. An update replaces the whole map. |
| `handoff_category_desc`             | object  |           | Descriptions shown beneath each handoff category, keyed by category key. An update replaces the whole map.                                         |
| `handoff_item_names`                | object  |           | Display titles for handoff items, keyed by item key. Each key must match a configured handoff item. An update replaces the whole map.              |
| `handoff_item_descs`                | object  |           | Descriptions shown beneath each handoff item, keyed by item key. An update replaces the whole map.                                                 |
| `handoff_item_action_texts`         | object  |           | Button label for each handoff item, keyed by item key, for example Visit Facilities Portal. An update replaces the whole map.                      |
| `handoff_item_disclaimers`          | object  |           | Additional information or disclaimer shown under a handoff item, keyed by item key. An update replaces the whole map.                              |
| `welcome_message_to_portal_mapping` | object  |           | Web chat welcome message for each portal, keyed by portal system name. Overrides default_welcome_message for that portal.                          |
| `default_welcome_message`           | string  |           | Welcome message shown when users first open web chat, for portals without a specific message.                                                      |
| `webchat_chatbox_placeholder`       | string  |           | Placeholder text shown in the web chat input box.                                                                                                  |
| `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
{
  "bot_friendly_name": "example-name",
  "handoff_category_names": {},
  "handoff_category_desc": {},
  "handoff_item_names": {},
  "handoff_item_descs": {},
  "handoff_item_action_texts": {},
  "handoff_item_disclaimers": {},
  "welcome_message_to_portal_mapping": {}
}
```