Skip to navigation

Update native plugin 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.
searchobjectOptional
Settings for search plugins, such as forms, rooms, people and enterprise search.
user_preferencesobjectOptional
Settings for user preference plugins, such as changing the response language.
ticketingobjectOptional
Settings for ticketing plugins, such as viewing, resolving, reopening and commenting on tickets.
access_provisioningobjectOptional
Settings for access provisioning plugins, such as distribution list management and software access.
access_accountobjectOptional
Settings for account access plugins, such as unlocking accounts and resetting passwords or MFA.
approvalsobjectOptional
Settings for approvals plugins, such as viewing, listing and acting on approval records.
llm_passthroughobjectOptional
Settings for general writing plugins, such as writing emails and translating text.
smart_handoffobjectOptional
Settings for the smart handoff plugin.
gptobjectOptional
Settings for generative AI plugins, such as QuickGPT and world knowledge web search.

Response

The updated native plugin settings, at its new version
searchobjectOptional
Settings for search plugins, such as forms, rooms, people and enterprise search.
user_preferencesobjectOptional
Settings for user preference plugins, such as changing the response language.
ticketingobjectOptional
Settings for ticketing plugins, such as viewing, resolving, reopening and commenting on tickets.
access_provisioningobjectOptional
Settings for access provisioning plugins, such as distribution list management and software access.
access_accountobjectOptional
Settings for account access plugins, such as unlocking accounts and resetting passwords or MFA.
approvalsobjectOptional
Settings for approvals plugins, such as viewing, listing and acting on approval records.
llm_passthroughobjectOptional
Settings for general writing plugins, such as writing emails and translating text.
smart_handoffobjectOptional
Settings for the smart handoff plugin.
gptobjectOptional
Settings for generative AI plugins, such as QuickGPT and world knowledge web search.
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