Skip to navigation

Tenant General Information

View as Markdown

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.

MethodPathEndpoint reference
GET/platform/tenant/general-informationGet tenant general information
PATCH/platform/tenant/general-informationUpdate tenant general information

Fields

FieldTypeRequiredNotes
company_namestringDisplay-friendly name of your company (e.g. Moveworks). Used in analytics dashboards.
email_domainstringYour company’s default email domain (e.g. company.com).
additional_email_domainsarray<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_stageenumStage 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_datestringDate your Moveworks implementation goes live, in YYYY-MM-DD format. Analytics and alerts are generated only after this date.
custom_domain_aliasstringAlias 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_urlstringPublicly 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_urlstringPublicly 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_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersionDocument 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.

{
"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"
}