Sign in

v4

latestOpenAPI 3.0.12026-07-1381649.6 KB
Basic

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

Path parameters

objectTypestring required

Request body

allowsSensitivePropertiesboolean
clearDescriptionboolean required
descriptionstring
primaryDisplayPropertystring

The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.

requiredPropertiesstring[]

The names of properties that should be required when creating an object of this type.

restorableboolean
searchablePropertiesstring[]

Names of properties that will be indexed for this object type in by HubSpot's product search.

secondaryDisplayPropertiesstring[]

The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.

Response

successful operation

allowsSensitivePropertiesboolean required
archivedboolean required
createdAtstring date-time

When the object type was created.

descriptionstring
fullyQualifiedNamestring required
idstring required

A unique ID for this object type. Will be defined as {meta-type}-{unique ID}.

namestring required

A unique name for this object. For internal use only.

objectTypeIdstring required
portalIdinteger

The ID of the account that this object type is specific to.

primaryDisplayPropertystring

The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.

requiredPropertiesstring[] required

The names of properties that should be required when creating an object of this type.

searchablePropertiesstring[] required

Names of properties that will be indexed for this object type in by HubSpot's product search.

secondaryDisplayPropertiesstring[] required

The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.

updatedAtstring date-time

When the object type was last updated.