v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB
Basic

Update the schema of a specified custom object.

Update attributes of a custom object schema, such as properties and labels, using the object type ID or fully qualified name.

patch/crm-object-schemas/2026-03/schemas/{objectType}

Path parameters

objectTypestring required

Request body

allowsSensitivePropertiesboolean
clearDescriptionboolean required
descriptionstring
primaryDisplayPropertystring
requiredPropertiesstring[]
restorableboolean
searchablePropertiesstring[]
secondaryDisplayPropertiesstring[]

Response

successful operation

allowsSensitivePropertiesboolean required
archivedboolean required
createdAtstring date-time
descriptionstring
fullyQualifiedNamestring required
idstring required
namestring required
objectTypeIdstring required
portalIdinteger
primaryDisplayPropertystring
requiredPropertiesstring[] required
searchablePropertiesstring[] required
secondaryDisplayPropertiesstring[] required
updatedAtstring date-time