Skip to navigation
Custom ObjectsObject Type Management

updateObjectType

View as Markdown

Update a custom object type.

Updates an existing custom object type definition (name, description, logo, icon) and can replace workspace tags with workspace_ids, or change scope between GLOBAL and WORKSPACE.

Parameters

NameTypeRequiredDescription
objectTypeIdintegerYesThe object type ID (from listObjectTypes)
namestringNo
descriptionstringNo
logo_urlstringNo
iconobjectNo
display_id_prefixstringNoDisplay ID prefix for instances (e.g., “VEN” for Vendor → VEN-1).
workspace_idsinteger[]NoFull replacement of object-type workspace visibility tags. Direct-write —
scopeobjectNo