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

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

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

- `version` (HandoffVersionPatch, required) — Document version. On update, send back the num from your last read.
- `category_settings` (list of HandoffCategorySettingPatch, optional) — Handoff categories. Handoff items are grouped into categories by display key.
- `item_settings` (list of HandoffItemSettingPatch, optional) — Handoff items: the individual handoff options shown to users.

## Response

### 200

The updated handoff, at its new version

- `category_settings` (list of HandoffCategorySetting, optional) — Handoff categories. Handoff items are grouped into categories by display key.
- `item_settings` (list of HandoffItemSetting, optional) — Handoff items: the individual handoff options shown to users.
- `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

### HandoffVersionPatch

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

### HandoffCategorySettingPatch

- `display_key` (string, optional) — Unique key identifying the handoff category, e.g. 'it', 'hr', 'facility'. Not shown to users. 2 to 80 characters.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### HandoffItemSettingPatch

- `display_key` (string, optional) — Unique key identifying the handoff item, e.g. 'it_file_ticket', 'hr_pto'. Not shown to users. 2 to 80 characters.
- `metadata` (ItemMetadata, optional) — Characteristics of this item, such as its domain, used for analytics tracking.
- `endpoint_setting` (HandoffEndpointSetting, optional) — Where this handoff routes the user, such as a URL, email address, chat channel or ticket form.
- `pretrigger_rule_dsl` (string, optional) — Moveworks DSL rule that controls when this handoff is shown.
- `category_display_keys` (list of string, optional) — Display keys of the categories this item belongs to. 1 to 3 values.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### HandoffCategorySetting

- `display_key` (string, optional) — Unique key identifying the handoff category, e.g. 'it', 'hr', 'facility'. Not shown to users. 2 to 80 characters.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### HandoffItemSetting

- `display_key` (string, optional) — Unique key identifying the handoff item, e.g. 'it_file_ticket', 'hr_pto'. Not shown to users. 2 to 80 characters.
- `metadata` (ItemMetadata, optional) — Characteristics of this item, such as its domain, used for analytics tracking.
- `endpoint_setting` (HandoffEndpointSetting, optional) — Where this handoff routes the user, such as a URL, email address, chat channel or ticket form.
- `pretrigger_rule_dsl` (string, optional) — Moveworks DSL rule that controls when this handoff is shown.
- `category_display_keys` (list of string, optional) — Display keys of the categories this item belongs to. 1 to 3 values.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

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

### ItemMetadata

- `domain` (enum, optional)
  - Allowed values: `UNKNOWN_DOMAIN`, `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`, `UNSPECIFIED_DOMAIN`

### HandoffEndpointSetting

- `endpoint_type` (enum, optional) — Type of handoff: DEFLECTION (default) for a URL, email or chat channel, FILE_TICKET for ticket filing, or AGENT_HANDOFF for a live agent.
  - Allowed values: `HANDOFF_ENDPOINT_TYPE_DEFLECTION`, `HANDOFF_ENDPOINT_TYPE_FILE_TICKET`, `HANDOFF_ENDPOINT_TYPE_AGENT_HANDOFF`
- `url` (string, optional) — URL the user is sent to.
- `email_addr` (string, optional) — Email address the handoff is routed to.
- `chat_channel_id` (string, optional) — ID of the chat channel the handoff is routed to.
- `rich_ticket_form_reference` (string, optional) — Form used for rich ticket filing. Use with the FILE_TICKET endpoint type. ID of an existing ticket_rich_text_form (GET /configurations/v1alpha1/tool/ticket/rich-text-forms).
- `live_agent_reference` (string, optional) — Live agent configuration this handoff routes the user to, for the AGENT_HANDOFF endpoint type. ID of an existing live_agent_integration (GET /configurations/v1alpha1/tool/live-agent/integrations).

## Examples

### Handoff endpoints_updateHandoff_example

**Response**

```json
{
  "category_settings": [
    {
      "display_key": "<string>",
      "item_ref": "<string>"
    }
  ],
  "item_settings": [
    {
      "display_key": "<string>",
      "metadata": {},
      "endpoint_setting": {
        "endpoint_type": "HANDOFF_ENDPOINT_TYPE_DEFLECTION",
        "url": "https://example.com/path"
      },
      "pretrigger_rule_dsl": "true",
      "category_display_keys": [
        "<string>"
      ],
      "item_ref": "<string>"
    }
  ],
  "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 Handoff endpoints_updateHandoff_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/tool/handoff"

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

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

print(response.json())
```

```javascript Handoff endpoints_updateHandoff_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/tool/handoff';
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 Handoff endpoints_updateHandoff_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/tool/handoff"

	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 Handoff endpoints_updateHandoff_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/tool/handoff")

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 Handoff endpoints_updateHandoff_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/handoff")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Handoff endpoints_updateHandoff_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp Handoff endpoints_updateHandoff_example
using RestSharp;

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

```swift Handoff endpoints_updateHandoff_example
import Foundation

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

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

**Request**

```json
{
  "version": {
    "change_description": "Update via the Configuration API",
    "num": 2
  },
  "category_settings": [
    {
      "display_key": "<string>",
      "item_ref": "<string>"
    }
  ]
}
```

**Response**

```json
{
  "category_settings": [
    {
      "display_key": "<string>",
      "item_ref": "<string>"
    }
  ],
  "item_settings": [
    {
      "display_key": "<string>",
      "metadata": {},
      "endpoint_setting": {
        "endpoint_type": "HANDOFF_ENDPOINT_TYPE_DEFLECTION",
        "url": "https://example.com/path"
      },
      "pretrigger_rule_dsl": "true",
      "category_display_keys": [
        "<string>"
      ],
      "item_ref": "<string>"
    }
  ],
  "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 handoff
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/tool/handoff"

payload = {
    "version": {
        "change_description": "Update via the Configuration API",
        "num": 2
    },
    "category_settings": [
        {
            "display_key": "<string>",
            "item_ref": "<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 handoff
const url = 'https://api.moveworks.ai/configurations/v1alpha1/tool/handoff';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"version":{"change_description":"Update via the Configuration API","num":2},"category_settings":[{"display_key":"<string>","item_ref":"<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 handoff
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/tool/handoff"

	payload := strings.NewReader("{\n  \"version\": {\n    \"change_description\": \"Update via the Configuration API\",\n    \"num\": 2\n  },\n  \"category_settings\": [\n    {\n      \"display_key\": \"<string>\",\n      \"item_ref\": \"<string>\"\n    }\n  ]\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 handoff
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/tool/handoff")

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  \"category_settings\": [\n    {\n      \"display_key\": \"<string>\",\n      \"item_ref\": \"<string>\"\n    }\n  ]\n}"

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

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

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/tool/handoff")
  .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  \"category_settings\": [\n    {\n      \"display_key\": \"<string>\",\n      \"item_ref\": \"<string>\"\n    }\n  ]\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp Change one field of the handoff
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/tool/handoff");
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  \"category_settings\": [\n    {\n      \"display_key\": \"<string>\",\n      \"item_ref\": \"<string>\"\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Change one field of the handoff
import Foundation

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

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

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