Skip to navigation

Update domain

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. The id goes in the URL; if you also send id in the body it must match.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The id of the domain, 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.
descriptionstringOptional>=1 character
Description of the domain, used to decide when a request belongs to it. Required.
positive_exampleslist of stringsOptional
Example user requests that belong to this domain and boost its signal. 1 to 500 examples, each up to 250 characters.
negative_exampleslist of stringsOptional
Example user requests that do not belong to this domain and reduce its signal. Up to 100 examples, each up to 250 characters.

Response

The updated domain, at its new version
idstringOptionalRead-only
Unique identifier of the domain, assigned by the server. Cannot be changed.
namestringOptional>=1 character

Name of the domain, for example Manufacturing. Must match a Smart Handoff category key (case insensitive) and be unique. Cannot be changed after creation.

descriptionstringOptional>=1 character
Description of the domain, used to decide when a request belongs to it. Required.
positive_exampleslist of stringsOptional
Example user requests that belong to this domain and boost its signal. 1 to 500 examples, each up to 250 characters.
negative_exampleslist of stringsOptional
Example user requests that do not belong to this domain and reduce its signal. Up to 100 examples, each up to 250 characters.
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
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error