API ReferenceLabels

Update a label

Update a label. Records and Minis reference labels by name, so changing the name moves them onto the new one in the background: the response carries a rename state that clears once they have all moved, and further edits are refused until then.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.
idstringRequired
namestring or nullOptional
descriptionstring or nullOptional
colourstring or nullOptional
iconstring or nullOptional
resourceTypeenum or nullOptional
labelGroupIdstring or nullOptional

Response

OK
idstring
namestring
resourceTypeenum
labelGroupIdstring or nullOptional
descriptionstring or nullOptional
colourstring or nullOptional
iconstring or nullOptional
renameobject or nullOptional
createdAtdatetimeOptional
updatedAtdatetimeOptional

Errors

400
Bad Request Error
404
Not Found Error