> 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 data type

PATCH https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/data-types/{id}
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, `null` clears it, and nested objects merge field by field. Lists of objects merge row by row instead of being replaced, so read the document first and send the whole list back when you reorder or remove rows. Lists of strings, Data Mapper expressions, JSON schemas, `workflow_steps` and `resolver_methods` are replaced whole. The `id` goes in the URL; if you also send `id` in the body it must match.

Reference: https://docs.moveworks.com/api-reference/configuration-api/tool-studio/data-types/update-data-type

## Authentication

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

## Request

### Path parameters

- `id` (string, required) — The `id` of the data type, as returned when it was created or listed.

### Body (application/json)

This endpoint expects a DataTypePatch.

- `version` (DataTypeVersionPatch, required) — Document version. On update, send back the num from your last read.
- `friendly_name` (string, optional) — User-friendly display name for the data type (3 to 64 characters).
- `description` (string, optional) — Description of what the data type represents (3 to 256 characters).
- `schema` (DataTypePatchSchema, optional) — JSON schema for one instance of the data type. Required.
- `resolution_strategy` (DataTypeResolutionStrategyPatch, optional) — Default resolution strategy used to resolve values of this data type. Required.
- `system_usage_config` (DataTypeSystemUsageConfig, optional) — Controls which fields the assistant sees and uses for citations and identification.

## Response

### 200

The updated data type, at its new version

- `id` (string, optional) — Unique identifier of the data type, assigned by the server. Cannot be changed.
- `name` (string, optional) — Type name derived from friendly_name on create, in the format u_PascalCase (for example, Purchase Order becomes u_PurchaseOrder). Read-only.
- `friendly_name` (string, optional) — User-friendly display name for the data type (3 to 64 characters).
- `description` (string, optional) — Description of what the data type represents (3 to 256 characters).
- `schema` (DataTypeSchema, optional) — JSON schema for one instance of the data type. Required.
- `resolution_strategy` (DataTypeResolutionStrategy, optional) — Default resolution strategy used to resolve values of this data type. Required.
- `system_usage_config` (DataTypeSystemUsageConfig, optional) — Controls which fields the assistant sees and uses for citations and identification.
- `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.
- `type_id` (string, optional) — Value other resources store to reference this data type, such as a slot's type.custom. Assigned by the server and different in each tenant.

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

### 404 Not Found Error

Not found - no item with this `id` exists in 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

### DataTypeVersionPatch

- `num` (integer, required) — 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, required) — A short note describing this change. Required on every create and update.

### DataTypePatchSchema

JSON schema for one instance of the data type. Required.

### DataTypeResolutionStrategyPatch

- `resolver_methods` (list of DataTypeResolverMethodPatch, optional) — Independent methods that can resolve a value of this type. On update, a provided list replaces all existing methods; omit it to keep them.

### DataTypeSystemUsageConfig

- `summary_projection` (DataTypeSystemUsageConfigSummaryProjection, optional) — Reduced JSON schema listing which fields the assistant sees when handling a list of values of this type.
- `detailed_projection` (DataTypeSystemUsageConfigDetailedProjection, optional) — Reduced JSON schema listing which fields the assistant sees when handling a single value of this type.
- `mentionable_fields` (list of string, optional) — Fields that can anchor citations in the reference popup. Set it to show citations for this data type.
- `identifiable_fields` (list of string, optional) — Fields that uniquely or nearly uniquely identify a value (for example full_name or email_addr for a user). Optional, but improves disambiguation.

### DataTypeSchema

JSON schema for one instance of the data type. Required.

### DataTypeResolutionStrategy

- `name` (string, optional) — Unique name of the resolution strategy. Cannot be changed after creation.
- `resolver_methods` (list of DataTypeResolverMethod, optional) — Independent methods that can resolve a value of this type. On update, a provided list replaces all existing methods; omit it to keep them.

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

### DataTypeResolverMethodPatch

- `id` (string, optional) — Name of the resolver method, unique within the strategy. Letters, digits and underscores only, starting with a letter or underscore (up to 64 characters).
- `input_schema` (DataTypeResolverMethodPatchInputSchema, optional) — JSON schema describing the inputs this method accepts.
- `dynamic_lookup` (DataTypeDynamicLookup, optional) — Looks up candidate values by running an action.
- `static_options` (DataTypeStaticOptionsPatch, optional) — Chooses a value from a static list of candidates.

### DataTypeSystemUsageConfigSummaryProjection

Reduced JSON schema listing which fields the assistant sees when handling a list of values of this type.

### DataTypeSystemUsageConfigDetailedProjection

Reduced JSON schema listing which fields the assistant sees when handling a single value of this type.

### DataTypeResolverMethod

- `id` (string, optional) — Name of the resolver method, unique within the strategy. Letters, digits and underscores only, starting with a letter or underscore (up to 64 characters).
- `input_schema` (DataTypeResolverMethodInputSchema, optional) — JSON schema describing the inputs this method accepts.
- `dynamic_lookup` (DataTypeDynamicLookup, optional) — Looks up candidate values by running an action.
- `static_options` (DataTypeStaticOptions, optional) — Chooses a value from a static list of candidates.

### DataTypeResolverMethodPatchInputSchema

JSON schema describing the inputs this method accepts.

### DataTypeDynamicLookup

- `http_action` (string, optional) — HTTP action that looks up the candidate values. The action must return synchronously. ID of an existing http_action (GET /configurations/v1alpha1/platform/extensions/http-actions).
- `compound_action` (string, optional) — Compound action that looks up the candidate values. The action must return synchronously. ID of an existing compound_action (GET /configurations/v1alpha1/platform/extensions/compound-actions).
- `script_action` (string, optional) — Script action that looks up the candidate values. The action must return synchronously. ID of an existing script (GET /configurations/v1alpha1/platform/extensions/scripts).
- `built_in_action` (enum, optional) — Built-in action that looks up the candidate values, such as get_user_by_email or batch_get_users_by_email.
  - 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`
- `input_mapper` (DataTypeDynamicLookupInputMapper, optional, nullable) — Mapping from the resolver method input to the action arguments.
- `output_mapper` (DataTypeDynamicLookupOutputMapper, optional, nullable) — Mapping from the action result to the resolved value, or to a list of candidate values.
- `produces_multiple_candidates` (boolean, optional) — If true, the action returns a list of candidate values that the user must choose from.

### DataTypeStaticOptionsPatch

- `options` (list of DataTypeStaticOption, optional) — Candidate values to choose from. At least one is required.

### DataTypeResolverMethodInputSchema

JSON schema describing the inputs this method accepts.

### DataTypeStaticOptions

- `options` (list of DataTypeStaticOption, optional) — Candidate values to choose from. At least one is required.

### DataTypeDynamicLookupInputMapper

Mapping from the resolver method input to the action arguments.

- string
- double
- integer
- boolean
- map from string to any
- list of any

### DataTypeDynamicLookupOutputMapper

Mapping from the action result to the resolved value, or to a list of candidate values.

- string
- double
- integer
- boolean
- map from string to any
- list of any

### DataTypeStaticOption

- `display_name` (string, optional) — Short user-friendly name for this candidate value.
- `value` (DataTypeStaticOptionValue, optional, nullable) — The fully defined candidate value. Required.

### DataTypeStaticOptionValue

The fully defined candidate value. Required.

- string
- double
- integer
- boolean
- map from string to any
- list of any

## Examples

### Data Types endpoints_updateDataType_example

**Response**

```json
{
  "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
  "friendly_name": "Purchase Order",
  "description": "A purchase order in the production ERP.",
  "schema": {
    "properties": {
      "id": {
        "type": "string"
      },
      "status": {
        "type": "string"
      },
      "total": {
        "type": "number"
      }
    },
    "type": "object"
  },
  "resolution_strategy": {
    "name": "purchase_order_resolution",
    "resolver_methods": [
      {
        "id": "by_po_number",
        "input_schema": {
          "properties": {
            "po_number": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "dynamic_lookup": {
          "http_action": "1b7d4f5a-2c88-4e0b-9f31-7c5a0d9e4411",
          "input_mapper": {
            "po_number": "data.po_number"
          },
          "produces_multiple_candidates": false
        }
      }
    ]
  },
  "system_usage_config": {
    "mentionable_fields": [
      "id",
      "status"
    ],
    "identifiable_fields": [
      "id"
    ]
  },
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 3,
    "change_description": "Update the data type"
  }
}
```

**SDK Code**

```python Data Types endpoints_updateDataType_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/data-types/id"

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

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

print(response.json())
```

```javascript Data Types endpoints_updateDataType_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/data-types/id';
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 Data Types endpoints_updateDataType_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/data-types/id"

	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 Data Types endpoints_updateDataType_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/data-types/id")

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 Data Types endpoints_updateDataType_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/data-types/id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Data Types endpoints_updateDataType_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp Data Types endpoints_updateDataType_example
using RestSharp;

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

```swift Data Types endpoints_updateDataType_example
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/data-types/id")! 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 a data type

**Request**

```json
{
  "version": {
    "num": 2,
    "change_description": "Update the data type"
  },
  "description": "A purchase order in the production ERP."
}
```

**Response**

```json
{
  "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
  "friendly_name": "Purchase Order",
  "description": "A purchase order in the production ERP.",
  "schema": {
    "properties": {
      "id": {
        "type": "string"
      },
      "status": {
        "type": "string"
      },
      "total": {
        "type": "number"
      }
    },
    "type": "object"
  },
  "resolution_strategy": {
    "name": "purchase_order_resolution",
    "resolver_methods": [
      {
        "id": "by_po_number",
        "input_schema": {
          "properties": {
            "po_number": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "dynamic_lookup": {
          "http_action": "1b7d4f5a-2c88-4e0b-9f31-7c5a0d9e4411",
          "input_mapper": {
            "po_number": "data.po_number"
          },
          "produces_multiple_candidates": false
        }
      }
    ]
  },
  "system_usage_config": {
    "mentionable_fields": [
      "id",
      "status"
    ],
    "identifiable_fields": [
      "id"
    ]
  },
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 3,
    "change_description": "Update the data type"
  }
}
```

**SDK Code**

```python Change a data type
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/data-types/id"

payload = {
    "version": {
        "num": 2,
        "change_description": "Update the data type"
    },
    "description": "A purchase order in the production ERP."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Change a data type
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/data-types/id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"version":{"num":2,"change_description":"Update the data type"},"description":"A purchase order in the production ERP."}'
};

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

```go Change a data type
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/data-types/id"

	payload := strings.NewReader("{\n  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update the data type\"\n  },\n  \"description\": \"A purchase order in the production ERP.\"\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 a data type
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/data-types/id")

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    \"num\": 2,\n    \"change_description\": \"Update the data type\"\n  },\n  \"description\": \"A purchase order in the production ERP.\"\n}"

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

```java Change a data type
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/data-types/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update the data type\"\n  },\n  \"description\": \"A purchase order in the production ERP.\"\n}")
  .asString();
```

```php Change a data type
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/data-types/id', [
  'body' => '{
  "version": {
    "num": 2,
    "change_description": "Update the data type"
  },
  "description": "A purchase order in the production ERP."
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Change a data type
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/data-types/id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update the data type\"\n  },\n  \"description\": \"A purchase order in the production ERP.\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Change a data type
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "version": [
    "num": 2,
    "change_description": "Update the data type"
  ],
  "description": "A purchase order in the production ERP."
] as [String : Any]

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

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