Skip to navigation

Update data type

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, null clears it, and nested objects merge field by field. Lists of objects merge row by row instead of being replaced, so read the document first and send the whole list back when you reorder or remove rows. Lists of strings, Data Mapper expressions, JSON schemas, workflow_steps and resolver_methods are replaced 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 data type, 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.
friendly_namestringOptional3-64 characters

User-friendly display name for the data type (3 to 64 characters).

descriptionstringOptional3-256 characters

Description of what the data type represents (3 to 256 characters).

schemaobjectOptional
JSON schema for one instance of the data type. Required.
resolution_strategyobjectOptional
Default resolution strategy used to resolve values of this data type. Required.
system_usage_configobjectOptional
Controls which fields the assistant sees and uses for citations and identification.

Response

The updated data type, at its new version
idstringOptionalRead-only
Unique identifier of the data type, assigned by the server. Cannot be changed.
namestringOptionalRead-onlyformat: "^u_[A-Z][A-Za-z0-9]+$"5-32 characters

Type name derived from friendly_name on create, in the format u_PascalCase (for example, Purchase Order becomes u_PurchaseOrder). Read-only.

friendly_namestringOptional3-64 characters

User-friendly display name for the data type (3 to 64 characters).

descriptionstringOptional3-256 characters

Description of what the data type represents (3 to 256 characters).

schemaobjectOptional
JSON schema for one instance of the data type. Required.
resolution_strategyobjectOptional
Default resolution strategy used to resolve values of this data type. Required.
system_usage_configobjectOptional
Controls which fields the assistant sees and uses for citations and identification.
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.
type_idstringOptionalRead-only
Value other resources store to reference this data type, such as a slot's type.custom. Assigned by the server and different in each tenant.

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