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

# Identity Bot Account (Assistant Account)

> Read and update Identity Bot Account (Assistant Account) through the Moveworks Configuration API: endpoints, fields and examples.

`platform.identity.assistant-account`

The Moveworks assistant's service account. Each `itsm_id_info` entry enables Built-In Ticketing for that connector.

* **Endpoint:** `/platform/identity/assistant-account`  |  **Methods:** GET, PATCH
* **Request shape:** one per organization, so there is no `id`. It already exists: read it with `GET`, then `PATCH` the fields you want to change. Fields go at the top level of the JSON body, with no `resource` wrapper.
* **Updates:** a JSON merge-patch. Send only the fields you change, plus `version: {num, change_description}` with the `num` from your last read. Lists and maps you send replace the stored ones whole.

### Endpoints

All paths are relative to `https://api.moveworks.ai/configurations/v1alpha1`. Each endpoint page lists the request and response schema, an example, and the errors it can return.

| Method  | Path                                   | Endpoint reference                                                                                                                        |
| ------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `GET`   | `/platform/identity/assistant-account` | [Get assistant account](/api-reference/configuration-api/platform-org/identity-bot-account-assistant-account/get-assistant-account)       |
| `PATCH` | `/platform/identity/assistant-account` | [Update assistant account](/api-reference/configuration-api/platform-org/identity-bot-account-assistant-account/update-assistant-account) |

### Fields

| Field          | Type               | Required  | Notes                                                                                                                               |
| -------------- | ------------------ | --------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `email_addr`   | string             |           | Email address of the bot service account in your primary identity system.                                                           |
| `record_id`    | string             |           | Value that identifies the bot account across your systems, typically its email address. Must match your organization's joining key. |
| `full_name`    | string             |           | Full name of the bot service account.                                                                                               |
| `itsm_id_info` | array\<ITSMIdInfo> |           | Identities of the bot account in each connected ITSM system. Each entry enables built-in ticketing for that system.                 |
| `updated_time` | string             | read-only | When the configuration was last updated.                                                                                            |
| `updated_by`   | string             | read-only | Who last updated the configuration.                                                                                                 |
| `version`      | Version            |           | Document version. On update, send back the num from your last read.                                                                 |

### Document fields (example)

The document as `GET` returns it. To change any of these, send only the fields you want to change in the `PATCH` body.

```json
{
  "email_addr": "user@example.com",
  "record_id": "<id>",
  "full_name": "example-name",
  "itsm_id_info": [
    {
      "itsm_user_id": "<id>",
      "external_id": "<external-id>",
      "first_name": "example-name",
      "last_name": "example-name",
      "full_name": "example-name",
      "connector_id": "<connector-uuid>",
      "item_ref": "<string>"
    }
  ]
}
```