> 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 custom attribute entities

PATCH https://api.moveworks.ai/configurations/v1alpha1/platform/entities
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/platform-org/custom-attributes-entities/update-custom-attribute-entities

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

- `version` (CustomAttributeVersionPatch, required) — Document version. On update, send back the num from your last read.
- `registrations` (list of DataModelRegistrationPatch, optional) — Custom attributes registered for each data model.

## Response

### 200

The updated custom attribute entities, at its new version

- `registrations` (list of DataModelRegistration, optional) — Custom attributes registered for each data model.
- `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

### CustomAttributeVersionPatch

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

### DataModelRegistrationPatch

- `data_model` (enum, optional) — Data model the attributes belong to. One of USER, KNOWLEDGE_ARTICLE, TICKET or KNOWLEDGE_BASE.
  - Allowed values: `USER`, `KNOWLEDGE_ARTICLE`, `TICKET`, `KNOWLEDGE_BASE`
- `attributes` (list of CustomAttributePatch, optional) — Custom attributes expected on this data model.
- `item_ref` (string, optional) — Row identifier assigned by the server. Leave unset on create; on update, send back the value from your last read so the row is matched correctly.

### DataModelRegistration

- `data_model` (enum, optional) — Data model the attributes belong to. One of USER, KNOWLEDGE_ARTICLE, TICKET or KNOWLEDGE_BASE.
  - Allowed values: `USER`, `KNOWLEDGE_ARTICLE`, `TICKET`, `KNOWLEDGE_BASE`
- `attributes` (list of CustomAttribute, optional) — Custom attributes expected on this data model.
- `item_ref` (string, optional) — Row identifier assigned by the server. Leave unset on create; on update, send back the value from your last read so the row is matched correctly.

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

### CustomAttributePatch

- `name` (string, optional) — Name of the custom attribute. Case sensitive; must match the field name in the external system.
- `data_sensitivity` (DataSensitivity, optional) — Data sensitivity class applied to the attribute values.
- `item_ref` (string, optional) — Row identifier assigned by the server. Leave unset on create; on update, send back the value from your last read so the row is matched correctly.

### CustomAttribute

- `name` (string, optional) — Name of the custom attribute. Case sensitive; must match the field name in the external system.
- `data_sensitivity` (DataSensitivity, optional) — Data sensitivity class applied to the attribute values.
- `item_ref` (string, optional) — Row identifier assigned by the server. Leave unset on create; on update, send back the value from your last read so the row is matched correctly.

### DataSensitivity

- `customer_data` (enum, optional) — Classifies the attribute as customer data, for example CUSTOMER_DATA_USER_DATA or CUSTOMER_DATA_TICKET_DATA.
  - Allowed values: `CUSTOMER_DATA_UTTERANCE`, `CUSTOMER_DATA_INTEGRATION_DATA`, `CUSTOMER_DATA_CREDENTIAL`, `CUSTOMER_DATA_DEBUG`, `CUSTOMER_DATA_ID`, `CUSTOMER_DATA_URL`, `CUSTOMER_DATA_USER_DATA`, `CUSTOMER_DATA_TICKET_DATA`, `CUSTOMER_DATA_KNOWLEDGE_DATA`, `CUSTOMER_DATA_GROUP_DATA`, `CUSTOMER_DATA_DSL`, `CUSTOMER_DATA_COMMS`, `CUSTOMER_DATA_TICKET_ID`, `CUSTOMER_DATA_FORMS`, `CUSTOMER_DATA_ORG`, `CUSTOMER_DATA_BOT`, `CUSTOMER_DATA_TITLE`, `CUSTOMER_DATA_LOCATION`, `CUSTOMER_DATA_EVENT`, `CUSTOMER_DATA_SOFTWARE`, `CUSTOMER_DATA_HARDWARE`, `CUSTOMER_DATA_FILE`, `CUSTOMER_DATA_FILE_EXT`, `CUSTOMER_DATA_FILE_NAME`, `CUSTOMER_DATA_INDUSTRY`, `CUSTOMER_DATA_SENSITIVE_INTEGRATION`, `CUSTOMER_DATA_MW_RESPONSE`
- `pii_data` (enum, optional) — Classifies the attribute as personal data (PII), for example PII_EMAIL or PII_PHONE_NUMBER.
  - Allowed values: `PII_EMAIL`, `PII_NAME`, `PII_PHONE_NUMBER`, `PII_ADDRESS`, `PII_MONEY`, `PII_CREDIT_CARD`, `PII_SSN`, `PII_MAC_ADDR`, `PII_IP`, `PII_URL`, `PII_PIN_OR_OTP`, `PII_PASSWORD`, `PII_USERNAME`, `PII_IDENTIFICATION_NUMBER`, `PII_PASSPORT_NUMBER`, `PII_ACCOUNT_NUMBER`, `PII_DRIVERS_LICENSE`, `PII_TIME`, `PII_AGE`, `PII_DATE_OF_BIRTH`, `PII_MEDICAL_ISSUE`, `PII_IDENTIFIER`, `PII_GROUP_NAME`, `PII_DEMOGRAPHIC`, `PII_INSURANCE`, `PII_DEVICE_IDENTIFIER`

## Examples

### Custom Attributes (Entities) endpoints_updateCustomAttributeEntities_example

**Response**

```json
{
  "registrations": [
    {
      "data_model": "USER",
      "attributes": [
        {
          "name": "example-name",
          "data_sensitivity": {
            "customer_data": "CUSTOMER_DATA_UTTERANCE"
          },
          "item_ref": "<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 Custom Attributes (Entities) endpoints_updateCustomAttributeEntities_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/entities"

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

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

print(response.json())
```

```javascript Custom Attributes (Entities) endpoints_updateCustomAttributeEntities_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/entities';
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 Custom Attributes (Entities) endpoints_updateCustomAttributeEntities_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/entities"

	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 Custom Attributes (Entities) endpoints_updateCustomAttributeEntities_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/entities")

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 Custom Attributes (Entities) endpoints_updateCustomAttributeEntities_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/entities")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Custom Attributes (Entities) endpoints_updateCustomAttributeEntities_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp Custom Attributes (Entities) endpoints_updateCustomAttributeEntities_example
using RestSharp;

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

```swift Custom Attributes (Entities) endpoints_updateCustomAttributeEntities_example
import Foundation

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

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

**Request**

```json
{
  "version": {
    "change_description": "Update via the Configuration API",
    "num": 2
  },
  "registrations": [
    {
      "data_model": "USER",
      "attributes": [
        {
          "name": "example-name",
          "data_sensitivity": {
            "customer_data": "CUSTOMER_DATA_UTTERANCE"
          },
          "item_ref": "<string>"
        }
      ],
      "item_ref": "<string>"
    }
  ]
}
```

**Response**

```json
{
  "registrations": [
    {
      "data_model": "USER",
      "attributes": [
        {
          "name": "example-name",
          "data_sensitivity": {
            "customer_data": "CUSTOMER_DATA_UTTERANCE"
          },
          "item_ref": "<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 custom attribute entities
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/entities"

payload = {
    "version": {
        "change_description": "Update via the Configuration API",
        "num": 2
    },
    "registrations": [
        {
            "data_model": "USER",
            "attributes": [
                {
                    "name": "example-name",
                    "data_sensitivity": { "customer_data": "CUSTOMER_DATA_UTTERANCE" },
                    "item_ref": "<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 custom attribute entities
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/entities';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"version":{"change_description":"Update via the Configuration API","num":2},"registrations":[{"data_model":"USER","attributes":[{"name":"example-name","data_sensitivity":{"customer_data":"CUSTOMER_DATA_UTTERANCE"},"item_ref":"<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 custom attribute entities
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/entities"

	payload := strings.NewReader("{\n  \"version\": {\n    \"change_description\": \"Update via the Configuration API\",\n    \"num\": 2\n  },\n  \"registrations\": [\n    {\n      \"data_model\": \"USER\",\n      \"attributes\": [\n        {\n          \"name\": \"example-name\",\n          \"data_sensitivity\": {\n            \"customer_data\": \"CUSTOMER_DATA_UTTERANCE\"\n          },\n          \"item_ref\": \"<string>\"\n        }\n      ],\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 custom attribute entities
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/entities")

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  \"registrations\": [\n    {\n      \"data_model\": \"USER\",\n      \"attributes\": [\n        {\n          \"name\": \"example-name\",\n          \"data_sensitivity\": {\n            \"customer_data\": \"CUSTOMER_DATA_UTTERANCE\"\n          },\n          \"item_ref\": \"<string>\"\n        }\n      ],\n      \"item_ref\": \"<string>\"\n    }\n  ]\n}"

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

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

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/platform/entities")
  .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  \"registrations\": [\n    {\n      \"data_model\": \"USER\",\n      \"attributes\": [\n        {\n          \"name\": \"example-name\",\n          \"data_sensitivity\": {\n            \"customer_data\": \"CUSTOMER_DATA_UTTERANCE\"\n          },\n          \"item_ref\": \"<string>\"\n        }\n      ],\n      \"item_ref\": \"<string>\"\n    }\n  ]\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.moveworks.ai/configurations/v1alpha1/platform/entities', [
  'body' => '{
  "version": {
    "change_description": "Update via the Configuration API",
    "num": 2
  },
  "registrations": [
    {
      "data_model": "USER",
      "attributes": [
        {
          "name": "example-name",
          "data_sensitivity": {
            "customer_data": "CUSTOMER_DATA_UTTERANCE"
          },
          "item_ref": "<string>"
        }
      ],
      "item_ref": "<string>"
    }
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Change one field of the custom attribute entities
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/platform/entities");
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  \"registrations\": [\n    {\n      \"data_model\": \"USER\",\n      \"attributes\": [\n        {\n          \"name\": \"example-name\",\n          \"data_sensitivity\": {\n            \"customer_data\": \"CUSTOMER_DATA_UTTERANCE\"\n          },\n          \"item_ref\": \"<string>\"\n        }\n      ],\n      \"item_ref\": \"<string>\"\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Change one field of the custom attribute entities
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "version": [
    "change_description": "Update via the Configuration API",
    "num": 2
  ],
  "registrations": [
    [
      "data_model": "USER",
      "attributes": [
        [
          "name": "example-name",
          "data_sensitivity": ["customer_data": "CUSTOMER_DATA_UTTERANCE"],
          "item_ref": "<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/platform/entities")! 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()
```