API ReferenceRecords

Update a Record

Update a Record.

Authentication

AuthorizationBearer

Authenticate every request with Authorization: Bearer <api-key>. Manage keys in Workspace Admin > Security & access.

Path parameters

recordIdstringRequired

Either the Minikai-assigned Guid for this resource (e.g. abc12345-1234-1234-1234-123456789abc) or the resource’s externalUri, URL-encoded (e.g. https%3A%2F%2Fpartner.example.com%2Fpatients%2F48291). Responses always return the canonical Guid in the id field.

Request

This endpoint expects an object.
titlestringRequired
idstringOptionalformat: "uuid"
miniIdstring or nullOptional
descriptionstring or nullOptional
eventDatedatetime or nullOptional
schemaanyOptional
contentanyOptional
relationslist of objectsOptional
externalUristringOptionalformat: "uri"
labelslist of stringsOptional
tagsobjectOptional
authorizationobject or nullOptional
stateenumOptional
batchProcessbooleanOptional
eTagstring or nullOptional

Response

OK

Errors

400
Bad Request Error
404
Not Found Error