> 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 live agent message broker

PATCH https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker
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/handoff-live-agent/live-agent-message-broker/update-live-agent-message-broker

## 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 a MessageBrokeringConfigPatch.

- `version` (MessageBrokerVersionPatch, required) — Document version. On update, send back the num from your last read.
- `agent_always_available_enabled` (boolean, optional) — If true, agents are always treated as available and availability is not fetched from the agent's system.
- `pre_chat_sys_msg_limit_enabled` (boolean, optional) — If true, limits the number of system messages sent to the user before an agent connects.
- `pre_chat_sys_msg_limit` (integer, optional) — Maximum number of system messages sent to the user before an agent connects.
- `agent_language` (string, optional) — Language agents communicate in, as a two- or three-letter language code such as EN, ES or FR.
- `on_demand_machine_translation_enabled` (boolean, optional) — If true, messages are translated on demand based on the user's locale and the agent's language.
- `transcript_date_format` (string, optional) — Date format used in live agent transcripts: ISO (YYYY/MM/DD), US (MM/DD/YYYY) or European (DD/MM/YYYY).
- `file_attachment_size_limit_enabled` (boolean, optional) — If true, limits the size of a single file attachment.
- `file_attachment_size_limit` (long, optional) — Maximum file size, in MB, allowed for a single attachment.
- `total_file_attachment_allowed_per_session_enabled` (boolean, optional) — If true, limits the number of attachments allowed per live agent session.
- `total_file_attachment_allowed_per_session` (long, optional) — Maximum number of attachments allowed per live agent session.
- `pass_chat_history_disabled` (boolean, optional) — If true, the chat history is not passed to the agent when the live agent chat starts.
- `post_session_trigger_creator_studio_event_enabled` (boolean, optional) — If true, a custom event runs after the live agent session completes.
- `custom_event_uuid` (string, optional) — Custom event that runs after the live agent session completes. ID of an existing EventConfig; not available through the Configuration API.
- `history_passing_option` (LiveAgentHistoryPassingOptions, optional) — Options for how chat history is passed to the agent. Applies only when chat history passing is not disabled.
- `live_agent_transcript_enabled_dsl` (string, optional) — Moveworks DSL rule for which users can download a plain-text transcript after a live agent chat. Use 'true' to enable for all users.
- `csat_webhook_action` (CSATWebhookAction, optional) — Webhook action that runs after a live agent session ends to collect CSAT data.

## Response

### 200

The updated live agent message broker, at its new version

- `agent_always_available_enabled` (boolean, optional) — If true, agents are always treated as available and availability is not fetched from the agent's system.
- `pre_chat_sys_msg_limit_enabled` (boolean, optional) — If true, limits the number of system messages sent to the user before an agent connects.
- `pre_chat_sys_msg_limit` (integer, optional) — Maximum number of system messages sent to the user before an agent connects.
- `agent_language` (string, optional) — Language agents communicate in, as a two- or three-letter language code such as EN, ES or FR.
- `on_demand_machine_translation_enabled` (boolean, optional) — If true, messages are translated on demand based on the user's locale and the agent's language.
- `transcript_date_format` (string, optional) — Date format used in live agent transcripts: ISO (YYYY/MM/DD), US (MM/DD/YYYY) or European (DD/MM/YYYY).
- `file_attachment_size_limit_enabled` (boolean, optional) — If true, limits the size of a single file attachment.
- `file_attachment_size_limit` (long, optional) — Maximum file size, in MB, allowed for a single attachment.
- `total_file_attachment_allowed_per_session_enabled` (boolean, optional) — If true, limits the number of attachments allowed per live agent session.
- `total_file_attachment_allowed_per_session` (long, optional) — Maximum number of attachments allowed per live agent session.
- `pass_chat_history_disabled` (boolean, optional) — If true, the chat history is not passed to the agent when the live agent chat starts.
- `post_session_trigger_creator_studio_event_enabled` (boolean, optional) — If true, a custom event runs after the live agent session completes.
- `custom_event_uuid` (string, optional) — Custom event that runs after the live agent session completes. ID of an existing EventConfig; not available through the Configuration API.
- `history_passing_option` (LiveAgentHistoryPassingOptions, optional) — Options for how chat history is passed to the agent. Applies only when chat history passing is not disabled.
- `live_agent_transcript_enabled_dsl` (string, optional) — Moveworks DSL rule for which users can download a plain-text transcript after a live agent chat. Use 'true' to enable for all users.
- `csat_webhook_action` (CSATWebhookAction, optional) — Webhook action that runs after a live agent session ends to collect CSAT data.
- `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

### MessageBrokerVersionPatch

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

### LiveAgentHistoryPassingOptions

- `max_number_of_messages` (long, optional) — Maximum number of messages, user and bot combined, passed to the agent. Between 1 and 20.
- `remove_links_enabled` (boolean, optional) — If true, links are removed from the chat history before it is passed to agents.
- `remove_user_utterances_enabled` (boolean, optional) — If true, user messages are removed from the chat history before it is passed to agents.

### CSATWebhookAction

- `csat_webhook_action_enabled` (boolean, optional) — If true, the selected action runs as a CSAT webhook after the live agent session ends.
- `http_action` (string, optional) — HTTP action to run for the CSAT webhook. ID of an existing http_action (GET /configurations/v1alpha1/platform/extensions/http-actions).
- `compound_action` (string, optional) — Compound action to run for the CSAT webhook. ID of an existing compound_action (GET /configurations/v1alpha1/platform/extensions/compound-actions).
- `script_action` (string, optional) — Script action to run for the CSAT webhook. ID of an existing script (GET /configurations/v1alpha1/platform/extensions/scripts).
- `built_in_action` (enum, optional) — Built-in action to run for the CSAT webhook, such as send_plaintext_chat_notification or generate_text_action.
  - Allowed values: `batch_get_users_by_email`, `batch_send_plaintext_chat_notification`, `create_generic_approval_request`, `generate_structured_value_action`, `generate_text_action`, `get_user_by_email`, `run_script_action`, `send_plaintext_chat_notification`, `summarize_text_action`
- `noop` (NoopAction, optional) — Select this when no CSAT webhook action is required.
- `payload_mapper_bender` (CsatWebhookActionPayloadMapperBender, optional) — Data mapper that transforms live agent session data into the webhook payload, for example mapping session.session_id and user.email.

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

### NoopAction

### CsatWebhookActionPayloadMapperBender

Data mapper that transforms live agent session data into the webhook payload, for example mapping session.session_id and user.email.

## Examples

### Live Agent Message Broker endpoints_updateLiveAgentMessageBroker_example

**Response**

```json
{
  "agent_always_available_enabled": true,
  "pre_chat_sys_msg_limit_enabled": true,
  "pre_chat_sys_msg_limit": 1,
  "agent_language": "AF",
  "on_demand_machine_translation_enabled": true,
  "transcript_date_format": "ISO",
  "file_attachment_size_limit_enabled": true,
  "file_attachment_size_limit": 1,
  "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 Live Agent Message Broker endpoints_updateLiveAgentMessageBroker_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker"

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

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

print(response.json())
```

```javascript Live Agent Message Broker endpoints_updateLiveAgentMessageBroker_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker';
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 Live Agent Message Broker endpoints_updateLiveAgentMessageBroker_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker"

	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 Live Agent Message Broker endpoints_updateLiveAgentMessageBroker_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker")

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 Live Agent Message Broker endpoints_updateLiveAgentMessageBroker_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Live Agent Message Broker endpoints_updateLiveAgentMessageBroker_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp Live Agent Message Broker endpoints_updateLiveAgentMessageBroker_example
using RestSharp;

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

```swift Live Agent Message Broker endpoints_updateLiveAgentMessageBroker_example
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker")! 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 live agent message broker

**Request**

```json
{
  "version": {
    "change_description": "Update via the Configuration API",
    "num": 2
  },
  "agent_always_available_enabled": true
}
```

**Response**

```json
{
  "agent_always_available_enabled": true,
  "pre_chat_sys_msg_limit_enabled": true,
  "pre_chat_sys_msg_limit": 1,
  "agent_language": "AF",
  "on_demand_machine_translation_enabled": true,
  "transcript_date_format": "ISO",
  "file_attachment_size_limit_enabled": true,
  "file_attachment_size_limit": 1,
  "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 live agent message broker
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker"

payload = {
    "version": {
        "change_description": "Update via the Configuration API",
        "num": 2
    },
    "agent_always_available_enabled": True
}
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 live agent message broker
const url = 'https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"version":{"change_description":"Update via the Configuration API","num":2},"agent_always_available_enabled":true}'
};

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 live agent message broker
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker"

	payload := strings.NewReader("{\n  \"version\": {\n    \"change_description\": \"Update via the Configuration API\",\n    \"num\": 2\n  },\n  \"agent_always_available_enabled\": true\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 live agent message broker
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker")

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  \"agent_always_available_enabled\": true\n}"

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

```java Change one field of the live agent message broker
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker")
  .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  \"agent_always_available_enabled\": true\n}")
  .asString();
```

```php Change one field of the live agent message broker
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker', [
  'body' => '{
  "version": {
    "change_description": "Update via the Configuration API",
    "num": 2
  },
  "agent_always_available_enabled": true
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Change one field of the live agent message broker
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker");
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  \"agent_always_available_enabled\": true\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Change one field of the live agent message broker
import Foundation

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

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/message-broker")! 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()
```