> 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 service account

PATCH https://api.moveworks.ai/configurations/v1alpha1/platform/identity/service-accounts/{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, and every list or map you send replaces the stored one 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/platform-org/identity-service-accounts/update-service-account

## 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 service account, as returned when it was created or listed.

### Body (application/json)

This endpoint expects an IdentityServiceAccountConfigPatch.

- `version` (IdentityServiceAccountVersionPatch, required) — Document version. On update, send back the num from your last read.
- `email_addr` (string, optional) — Email address of the user in your primary identity system.
- `record_id` (string, optional) — Value that identifies this user across your systems, typically the email address. Must match your organization's joining key and be unique across service accounts. Required on create.
- `full_name` (string, optional) — Full name of the user.
- `user_name` (string, optional) — Username of the user.
- `first_name` (string, optional) — First name of the user.
- `last_name` (string, optional) — Last name of the user.
- `role` (string, optional) — Role or job title of the user.
- `manager_email_addr` (string, optional) — Email address of the user's manager.
- `department` (string, optional) — Department of the user.
- `location` (string, optional) — Location of the user.
- `country_code` (string, optional) — Country code of the user.
- `city` (string, optional) — City of the user.
- `region` (string, optional) — Region of the user.
- `division` (string, optional) — Division of the user.
- `timezone` (string, optional) — Timezone of the user.
- `employee_id` (string, optional) — Employee ID of the user.
- `cost_center_name` (string, optional) — Cost center name of the user.
- `work_status` (string, optional) — Employment classification of the user. One of: CONTINGENT, INTERN, FULL_TIME.
- `additional_email_addrs` (list of string, optional) — Additional email addresses that identify this user.
- `channel_id_info` (list of ChannelIdInfoPatch, optional) — Identities of the user in each connected chat system.
- `itsm_id_info` (list of ITSMIdInfoPatch, optional) — Identities of the user in each connected ITSM system. Each entry enables built-in ticketing for that system.
- `idm_id_info` (list of IDMIdInfoPatch, optional) — Identities of the user in each connected identity management system. Each entry enables access requests for that system.
- `tags` (list of enum, optional) — Moveworks user tags assigned to the user, e.g. VIP, IT_AGENT, TESTER or SERVICE_ACCOUNT.
  - Allowed values: `BASIC_USER`, `VIP`, `FIELD_AGENT`, `KNOWLEDGE_WORKER`, `IT_AGENT`, `TESTER`, `SUPPORTED_LANGUAGE_USER`, `SERVICE_ACCOUNT`, `CALL_CENTER`, `MOVEWORKS_INTERNAL_USER`, `HAS_ACCESS_TO_BOT`, `DIRECTOR`, `EXECUTIVE`, `BOT`, `SOCIAL_AUTH_USER`, `SITE_USER`
- `custom_attributes` (IdentityServiceAccountConfigPatchCustomAttributes, optional) — Custom attributes attached to the user. Replaced as a whole on update.

## Response

### 200

The updated service account, at its new version

- `id` (string, optional) — Unique identifier of the service account, assigned by the server.
- `email_addr` (string, optional) — Email address of the user in your primary identity system.
- `record_id` (string, optional) — Value that identifies this user across your systems, typically the email address. Must match your organization's joining key and be unique across service accounts. Required on create.
- `full_name` (string, optional) — Full name of the user.
- `user_name` (string, optional) — Username of the user.
- `first_name` (string, optional) — First name of the user.
- `last_name` (string, optional) — Last name of the user.
- `role` (string, optional) — Role or job title of the user.
- `manager_email_addr` (string, optional) — Email address of the user's manager.
- `department` (string, optional) — Department of the user.
- `location` (string, optional) — Location of the user.
- `country_code` (string, optional) — Country code of the user.
- `city` (string, optional) — City of the user.
- `region` (string, optional) — Region of the user.
- `division` (string, optional) — Division of the user.
- `timezone` (string, optional) — Timezone of the user.
- `employee_id` (string, optional) — Employee ID of the user.
- `cost_center_name` (string, optional) — Cost center name of the user.
- `work_status` (string, optional) — Employment classification of the user. One of: CONTINGENT, INTERN, FULL_TIME.
- `additional_email_addrs` (list of string, optional) — Additional email addresses that identify this user.
- `channel_id_info` (list of ChannelIdInfo, optional) — Identities of the user in each connected chat system.
- `itsm_id_info` (list of ITSMIdInfo, optional) — Identities of the user in each connected ITSM system. Each entry enables built-in ticketing for that system.
- `idm_id_info` (list of IDMIdInfo, optional) — Identities of the user in each connected identity management system. Each entry enables access requests for that system.
- `tags` (list of enum, optional) — Moveworks user tags assigned to the user, e.g. VIP, IT_AGENT, TESTER or SERVICE_ACCOUNT.
  - Allowed values: `BASIC_USER`, `VIP`, `FIELD_AGENT`, `KNOWLEDGE_WORKER`, `IT_AGENT`, `TESTER`, `SUPPORTED_LANGUAGE_USER`, `SERVICE_ACCOUNT`, `CALL_CENTER`, `MOVEWORKS_INTERNAL_USER`, `HAS_ACCESS_TO_BOT`, `DIRECTOR`, `EXECUTIVE`, `BOT`, `SOCIAL_AUTH_USER`, `SITE_USER`
- `custom_attributes` (IdentityServiceAccountConfigCustomAttributes, optional) — Custom attributes attached to the user. Replaced as a whole on update.
- `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)

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

### IdentityServiceAccountVersionPatch

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

### ChannelIdInfoPatch

- `user_channel_id` (string, optional) — User ID of the user in the chat system.
- `instance_name` (string, optional) — Name of the chat system instance, e.g. the workspace or tenant.
- `external_id` (string, optional) — External ID of the user in the chat system.
- `bot_id` (string, optional) — ID of the bot in the chat system.
- `connector_id` (string, optional) — ID of the chat connector this identity belongs to. Required. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `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.

### ITSMIdInfoPatch

- `itsm_user_id` (string, optional) — User ID of the account in the ITSM system.
- `external_id` (string, optional) — External ID of the account in the ITSM system.
- `first_name` (string, optional) — First name of the account in the ITSM system.
- `last_name` (string, optional) — Last name of the account in the ITSM system.
- `full_name` (string, optional) — Full name of the account in the ITSM system.
- `connector_id` (string, optional) — ID of the ITSM connector this identity belongs to. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `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.

### IDMIdInfoPatch

- `idm_user_id` (string, optional) — User ID of the user in the identity management system.
- `external_id` (string, optional) — External ID of the user in the identity management system.
- `login_type` (string, optional) — How the user signs in to the identity management system.
- `connector_id` (string, optional) — ID of the identity management connector this identity belongs to. Required. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `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.

### IdentityServiceAccountConfigPatchCustomAttributes

Custom attributes attached to the user. Replaced as a whole on update.

### ChannelIdInfo

- `user_channel_id` (string, optional) — User ID of the user in the chat system.
- `instance_name` (string, optional) — Name of the chat system instance, e.g. the workspace or tenant.
- `external_id` (string, optional) — External ID of the user in the chat system.
- `bot_id` (string, optional) — ID of the bot in the chat system.
- `connector_id` (string, optional) — ID of the chat connector this identity belongs to. Required. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `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.

### ITSMIdInfo

- `itsm_user_id` (string, optional) — User ID of the account in the ITSM system.
- `external_id` (string, optional) — External ID of the account in the ITSM system.
- `first_name` (string, optional) — First name of the account in the ITSM system.
- `last_name` (string, optional) — Last name of the account in the ITSM system.
- `full_name` (string, optional) — Full name of the account in the ITSM system.
- `connector_id` (string, optional) — ID of the ITSM connector this identity belongs to. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `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.

### IDMIdInfo

- `idm_user_id` (string, optional) — User ID of the user in the identity management system.
- `external_id` (string, optional) — External ID of the user in the identity management system.
- `login_type` (string, optional) — How the user signs in to the identity management system.
- `connector_id` (string, optional) — ID of the identity management connector this identity belongs to. Required. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `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.

### IdentityServiceAccountConfigCustomAttributes

Custom attributes attached to the user. Replaced as a whole on update.

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

## Examples

### Identity Service Accounts endpoints_updateServiceAccount_example

**Response**

```json
{
  "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
  "email_addr": "user@example.com",
  "record_id": "<id>",
  "full_name": "example-name",
  "user_name": "example-name",
  "first_name": "example-name",
  "last_name": "example-name",
  "role": "<string>",
  "manager_email_addr": "user@example.com",
  "department": "<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 Identity Service Accounts endpoints_updateServiceAccount_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/identity/service-accounts/id"

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

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

print(response.json())
```

```javascript Identity Service Accounts endpoints_updateServiceAccount_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/identity/service-accounts/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 Identity Service Accounts endpoints_updateServiceAccount_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/identity/service-accounts/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 Identity Service Accounts endpoints_updateServiceAccount_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/identity/service-accounts/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 Identity Service Accounts endpoints_updateServiceAccount_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/identity/service-accounts/id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Identity Service Accounts endpoints_updateServiceAccount_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp Identity Service Accounts endpoints_updateServiceAccount_example
using RestSharp;

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

```swift Identity Service Accounts endpoints_updateServiceAccount_example
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/platform/identity/service-accounts/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 one field of a service account

**Request**

```json
{
  "version": {
    "num": 2,
    "change_description": "Update via the Configuration API"
  },
  "email_addr": "user@example.com"
}
```

**Response**

```json
{
  "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
  "email_addr": "user@example.com",
  "record_id": "<id>",
  "full_name": "example-name",
  "user_name": "example-name",
  "first_name": "example-name",
  "last_name": "example-name",
  "role": "<string>",
  "manager_email_addr": "user@example.com",
  "department": "<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 a service account
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/identity/service-accounts/id"

payload = {
    "version": {
        "num": 2,
        "change_description": "Update via the Configuration API"
    },
    "email_addr": "user@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Change one field of a service account
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/identity/service-accounts/id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"version":{"num":2,"change_description":"Update via the Configuration API"},"email_addr":"user@example.com"}'
};

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 a service account
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/identity/service-accounts/id"

	payload := strings.NewReader("{\n  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update via the Configuration API\"\n  },\n  \"email_addr\": \"user@example.com\"\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 a service account
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/identity/service-accounts/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 via the Configuration API\"\n  },\n  \"email_addr\": \"user@example.com\"\n}"

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

```java Change one field of a service account
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/platform/identity/service-accounts/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update via the Configuration API\"\n  },\n  \"email_addr\": \"user@example.com\"\n}")
  .asString();
```

```php Change one field of a service account
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.moveworks.ai/configurations/v1alpha1/platform/identity/service-accounts/id', [
  'body' => '{
  "version": {
    "num": 2,
    "change_description": "Update via the Configuration API"
  },
  "email_addr": "user@example.com"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Change one field of a service account
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/platform/identity/service-accounts/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 via the Configuration API\"\n  },\n  \"email_addr\": \"user@example.com\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Change one field of a service account
import Foundation

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

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

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