Skip to navigation

Update productivity assistant

View as Markdown

Changes the fields you send and returns the full updated assistant.

Send only the fields you want to change, plus version with the num from your last read. A field you leave out keeps its stored value, an explicit null clears it, and every list is replaced whole. The assistant’s id goes in the URL; if you also send id in the body it must match.

For the rules that apply to specific fields, see How productivity assistant updates behave.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequiredformat: "uuid"

The id of the productivity assistant, as returned when it was created or listed.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
namestringOptional1-128 characters
Display name of the assistant. Unique within the organization.
descriptionstringOptional
What the assistant does, shown to users when choosing an assistant.
welcome_messagestringOptional
Message shown when a user opens the assistant.
iconstringOptional

Name of the assistant’s icon in the Moveworks icon set, as the Studio creator stores it (e.g. MWIconPublic). Not a URL.

instructionsstringOptional
Instructions that shape the assistant's behavior. Moveworks embeds them into the full system prompt.
conversation_starterslist of objectsOptional
Suggested prompts shown in a new conversation. Up to 10.
plugin_identifierslist of stringsOptional

Plugins the assistant may use, by plugin identifier (a native plugin name such as enterprise_search_plugin, or a Tool Studio plugin id). Empty means no plugins.

knowledge_scopeobjectOptional
Restricts enterprise search to selected systems, documents, workspaces and channels. Empty allows all content the user can already access.
skill_access_modestringOptional

Which skills the assistant may use: ALL includes every skill, including ones registered later; SELECTED uses only skill_ids. Unset on create stores SELECTED, so nothing is granted by omission; reads return ALL for assistants stored without a mode.

skill_idslist of stringsOptional

Skills the assistant may use when skill_access_mode is SELECTED. ID of an existing skill (GET /configurations/v1alpha1/assistant/skills).

mcp_server_idslist of stringsOptional

MCP servers whose tools the assistant may call. ID of an existing mcp_server (GET /configurations/v1alpha1/platform/extensions/mcp-workspace/servers).

a2a_agent_idslist of stringsOptional

External A2A agents the assistant may delegate to. ID of an existing A2AAgentConfig; not available through the Configuration API.

user_accessobjectOptional

Who can use the assistant. Exactly one of allow_all, allowed_emails or allowlist_rule_dsl; required on create. The creator always retains access.

Response

The updated productivity assistant, at its new version
idstringOptionalRead-only
Unique identifier of this assistant, assigned by the server.
namestringOptional1-128 characters
Display name of the assistant. Unique within the organization.
descriptionstringOptional
What the assistant does, shown to users when choosing an assistant.
welcome_messagestringOptional
Message shown when a user opens the assistant.
iconstringOptional

Name of the assistant’s icon in the Moveworks icon set, as the Studio creator stores it (e.g. MWIconPublic). Not a URL.

instructionsstringOptional
Instructions that shape the assistant's behavior. Moveworks embeds them into the full system prompt.
conversation_starterslist of objectsOptional
Suggested prompts shown in a new conversation. Up to 10.
plugin_identifierslist of stringsOptional

Plugins the assistant may use, by plugin identifier (a native plugin name such as enterprise_search_plugin, or a Tool Studio plugin id). Empty means no plugins.

knowledge_scopeobjectOptional
Restricts enterprise search to selected systems, documents, workspaces and channels. Empty allows all content the user can already access.
skill_access_modestringOptional

Which skills the assistant may use: ALL includes every skill, including ones registered later; SELECTED uses only skill_ids. Unset on create stores SELECTED, so nothing is granted by omission; reads return ALL for assistants stored without a mode.

skill_idslist of stringsOptional

Skills the assistant may use when skill_access_mode is SELECTED. ID of an existing skill (GET /configurations/v1alpha1/assistant/skills).

mcp_server_idslist of stringsOptional

MCP servers whose tools the assistant may call. ID of an existing mcp_server (GET /configurations/v1alpha1/platform/extensions/mcp-workspace/servers).

a2a_agent_idslist of stringsOptional

External A2A agents the assistant may delegate to. ID of an existing A2AAgentConfig; not available through the Configuration API.

user_accessobjectOptional

Who can use the assistant. Exactly one of allow_all, allowed_emails or allowlist_rule_dsl; required on create. The creator always retains access.

updated_timedatetimeOptionalRead-only
When the assistant was last updated.
updated_bystringOptionalRead-only
Who last updated the assistant.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

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