Skip to navigation

Update tenant general information

View as Markdown

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.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
company_namestringOptional>=1 character

Display-friendly name of your company (e.g. Moveworks). Used in analytics dashboards.

email_domainstringOptional>=1 character

Your company’s default email domain (e.g. company.com).

additional_email_domainslist of stringsOptional
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_stageenumOptional

Stage of your organization’s onboarding onto Moveworks. One of: DEV_INTEGRATION, PROD_INTEGRATION, IT_TESTING, LIMITED_ROLLOUT, LIVE, OFFLINE, OFFBOARDING, SANDBOX, PRESALES.

analytics_go_live_datestringOptional

Date your Moveworks implementation goes live, in YYYY-MM-DD format. Analytics and alerts are generated only after this date.

custom_domain_aliasstringOptional
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_urlstringOptional

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_urlstringOptional

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.

Response

The updated tenant general information, at its new version
company_namestringOptional>=1 character

Display-friendly name of your company (e.g. Moveworks). Used in analytics dashboards.

email_domainstringOptional>=1 character

Your company’s default email domain (e.g. company.com).

additional_email_domainslist of stringsOptional
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_stageenumOptional

Stage of your organization’s onboarding onto Moveworks. One of: DEV_INTEGRATION, PROD_INTEGRATION, IT_TESTING, LIMITED_ROLLOUT, LIVE, OFFLINE, OFFBOARDING, SANDBOX, PRESALES.

analytics_go_live_datestringOptional

Date your Moveworks implementation goes live, in YYYY-MM-DD format. Analytics and alerts are generated only after this date.

custom_domain_aliasstringOptional
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_urlstringOptional

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_urlstringOptional

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_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error