Skip to navigation

Update language settings

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.
machine_translation_localeslist of stringsOptional
Languages enabled through machine translation. They are instantly available in both the Moveworks Classic and AI Assistant experiences.
multi_languages_enabledstringOptional
Moveworks DSL rule for which users get multilingual support. Use 'true' to enable for all users.
ticket_translation_enabledstringOptional
Moveworks DSL rule for which users get translation of ticket filing and ticket comments.
use_ingested_user_default_localebooleanOptional

If true, a user’s preferred language from your ingested user records is used instead of the organization-wide default response language.

display_record_translation_enabledbooleanOptional
If true, field values in display records such as ticket notifications and people cards are translated.
translation_override_configslist of objectsOptional
Custom translations that replace the machine translation of specific source strings.
disable_translation_configslist of objectsOptional
Keywords after which text is not translated, per machine translation source.
locale_prompt_override_configslist of objectsOptional
Custom gender and formality instructions for specific locales.

Response

The updated language settings, at its new version
installed_localeslist of stringsOptional

Core languages installed for the organization, such as EN_US or FR_CA. Managed with the Moveworks MLS Operations team and cannot be changed through this API.

pending_translation_localeslist of stringsOptional
Languages requested for human translation, used only in the Moveworks Classic experience. Managed with the Moveworks MLS Operations team and cannot be changed through this API.
machine_translation_localeslist of stringsOptional
Languages enabled through machine translation. They are instantly available in both the Moveworks Classic and AI Assistant experiences.
default_dm_localestringOptional

Default non-English response language for all users. Leave blank for English. Must be an installed locale and cannot be changed through this API.

multi_languages_enabledstringOptional
Moveworks DSL rule for which users get multilingual support. Use 'true' to enable for all users.
ticket_translation_enabledstringOptional
Moveworks DSL rule for which users get translation of ticket filing and ticket comments.
use_ingested_user_default_localebooleanOptional

If true, a user’s preferred language from your ingested user records is used instead of the organization-wide default response language.

display_record_translation_enabledbooleanOptional
If true, field values in display records such as ticket notifications and people cards are translated.
translation_override_configslist of objectsOptional
Custom translations that replace the machine translation of specific source strings.
disable_translation_configslist of objectsOptional
Keywords after which text is not translated, per machine translation source.
locale_prompt_override_configslist of objectsOptional
Custom gender and formality instructions for specific locales.
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