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-09/schemas

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm-object-schemas/2026-09/schemas
  • Auth
    OAuth 2
    Authorization code: https://app.hubspot.com/oauth/authorize
    Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.schemas.custom.write

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.

shouldCreateSameObjectAssociationboolean required

A boolean indicating whether associations should be created between objects of the same type.

Response

successful operation

allowsSensitivePropertiesboolean required

A boolean indicating whether the object schema allows sensitive properties.

archivedboolean required

A boolean indicating whether the object schema is archived.

createdAtstring date-time

When the object schema was created.

createdByUserIdinteger

An integer representing the ID of the user who created the object schema.

descriptionstring

A string providing a description of the object schema.

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

A string representing the type ID of the object.

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

An integer representing the ID of the user who last updated the object schema.

Changes

  • 2026-098e557699eb26Revision changes
    • breaking

      added the new required request property

    • info

      the endpoint scheme security private_apps was removed from the API

    • info

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

    • info

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

    • info

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