post-crm-object-schemas-v3-schemas_schemas
Create a new custom object schema in HubSpot by specifying properties, labels, associations, and required fields.
Instructions
Create a new schema. REQUIRES body parameter with request data. Check the inputSchema for required body structure.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | A unique name for this object. For internal use only. | |
| labels | Yes | Singular and plural labels for the object. Used in CRM display. | |
| properties | Yes | Properties defined for this object type. | |
| description | No | string parameter | |
| associatedObjects | Yes | Associations defined for this object type. | |
| requiredProperties | Yes | The names of properties that should be **required** when creating an object of this type. | |
| searchableProperties | No | Names of properties that will be indexed for this object type in by HubSpot's product search. | |
| primaryDisplayProperty | No | The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type. | |
| secondaryDisplayProperties | No | The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type. |