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

# Tenant General Information

> Read and update Tenant General Information through the Moveworks Configuration API: endpoints, fields and examples.

`platform.tenant.general-information`

* **Endpoint:** `/platform/tenant/general-information`  |  **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/tenant/general-information` | [Get tenant general information](/api-reference/configuration-api/platform-org/tenant-general-information/get-tenant-general-information)       |
| `PATCH` | `/platform/tenant/general-information` | [Update tenant general information](/api-reference/configuration-api/platform-org/tenant-general-information/update-tenant-general-information) |

### Fields

| Field                           | Type           | Required  | Notes                                                                                                                                                                                                                                                                                                                     |
| ------------------------------- | -------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `company_name`                  | string         |           | Display-friendly name of your company (e.g. Moveworks). Used in analytics dashboards.                                                                                                                                                                                                                                     |
| `email_domain`                  | string         |           | Your company's default email domain (e.g. company.com).                                                                                                                                                                                                                                                                   |
| `additional_email_domains`      | array\<string> |           | Other email domains used in your company. Needed if admins sign in with domains other than the default email domain. Values must be unique.                                                                                                                                                                               |
| `onboarding_stage`              | enum           |           | Stage of your organization's onboarding onto Moveworks. One of: DEV_INTEGRATION, PROD_INTEGRATION, IT_TESTING, LIMITED_ROLLOUT, LIVE, OFFLINE, OFFBOARDING, SANDBOX, PRESALES. One of: `DEV_INTEGRATION`, `PROD_INTEGRATION`, `IT_TESTING`, `LIMITED_ROLLOUT`, `LIVE`, `OFFLINE`, `OFFBOARDING`, `SANDBOX`, … (9 values). |
| `analytics_go_live_date`        | string         |           | Date your Moveworks implementation goes live, in YYYY-MM-DD format. Analytics and alerts are generated only after this date.                                                                                                                                                                                              |
| `custom_domain_alias`           | string         |           | Alias for a custom MyMoveworks URL, e.g. 'company' for company.moveworks.com. If blank, my.moveworks.com is used. Requires OIDC to be configured in SSO settings.                                                                                                                                                         |
| `ai_assistant_avatar_image_url` | string         |           | Publicly accessible, direct URL to a PNG image (up to 1000x1000) used as the AI Assistant avatar. If blank, the default avatar is used.                                                                                                                                                                                   |
| `brand_logo_image_url`          | string         |           | Publicly accessible, direct URL to a PNG image (up to 600x72) shown as the brand logo in Web App navigation. If blank, the Moveworks logo is shown.                                                                                                                                                                       |
| `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
{
  "company_name": "example-name",
  "email_domain": "user@example.com",
  "additional_email_domains": [
    "user@example.com"
  ],
  "onboarding_stage": "DEV_INTEGRATION",
  "analytics_go_live_date": "2026-11-16",
  "custom_domain_alias": "acme.com",
  "ai_assistant_avatar_image_url": "https://example.com/path",
  "brand_logo_image_url": "https://example.com/path"
}
```