HUhubspot
Basic

Create a new custom object schema.

Changed on

Create a new custom object schema by defining its properties and associations.

post/crm-object-schemas/2026-03/schemas

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm-object-schemas/2026-03/schemas
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Request body

allowsSensitivePropertiesboolean required

Determines if the object type can include properties that are marked as sensitive.

associatedObjectsstring[] required

Associations defined for this object type.

descriptionstring

A brief explanation of the object type.

namestring required

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

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.

Response

successful operation

allowsSensitivePropertiesboolean required
archivedboolean required
createdAtstring date-time

When the object schema was created.

createdByUserIdinteger
descriptionstring
fullyQualifiedNamestring required

An assigned unique ID for the object, including portal ID and object name.

idstring required

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

namestring required

A unique name for the schema's object type.

objectTypeIdstring required
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 schema was last updated.

updatedByUserIdinteger

Changes

  • b0d8bc008db9Revision changes
    • info

      api operation id post-/crm-object-schemas/2026-03/schemas_create removed and replaced with post-/crm-object-schemas/2026-03/schemas

  • 3578967e48dfRevision changes
    • info

      added the optional property // to the response with the status

Some revisions have not been checked yet.