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.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Fully qualified name or object type ID of your schema.
Body
Attributes to update in your schema.
Defines attributes to update on an object type.
Determines if the object type can include properties that are marked as sensitive.
Indicates whether the description of the object type should be cleared.
A brief explanation of the object type.
Singular and plural labels for the object. Used in CRM display.
{
"plural": "My objects",
"singular": "My object"
}The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
The names of properties that should be required when creating an object of this type.
Specifies if the object type can be restored after being deleted.
Names of properties that will be indexed for this object type in by HubSpot's product search.
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
Defines an object type.
A unique ID for this object type. Will be defined as {meta-type}-{unique ID}.
Singular and plural labels for the object. Used in CRM display.
{
"plural": "My objects",
"singular": "My object"
}A unique name for this object. For internal use only.
The names of properties that should be required when creating an object of this type.
Indicates whether the object type allows properties that contain sensitive data.
Indicates whether the object type is archived.
When the object type was created.
A description of the object type.
An assigned unique ID for the object, including portal ID and object name.
A unique identifier for the object type.
The ID of the account that this object type is specific to.
The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
Names of properties that will be indexed for this object type in by HubSpot's product search.
The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
When the object type was last updated.