Create object type

POST /extensions/sales-objects/v1/object-types

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Developer Tools

Create a new CRM Extensions object type. 
Required Parameters How to use Description
Developer HAPIkey hapikey=
used in the request URL
Your Developer HAPIkey. This must be a Developer HAPIkey associated with the Developer portal that the OAuth app was created in.
Object details Used in the request body The JSON representing the details for the object type. See below for more details.

Each object type should have the following data. See the overview page for more details on how the object gets represented in HubSpot. See the example to the right for details on the format of these fields.

Field name Description
applicationId The ID of the HubSpot application that will own this object type.
baseUris A list of URIs. When you define actions, the URIs for these actions must be under one of these URIs.
dataFetchUri The URI the CRM will call to fetch Sales Objects for a given Contact, Company or Deal.
title The title of this object. This will be displayed as the title of the CRM sidebar card.
propertyDefinitions The common properties that these objects will have, in the order they should appear on the sidebar card. See Property Types for more info.
associatedHubSpotObjectTypes A set of CONTACT, COMPANY, or DEAL. This determines where on the CRM this Object Type will appear -- contact, company, or deal details pages.
associatedHubSpotObjectTypeProperties HubSpot properties to send in the data fetch request, by CRM object type.
Returns a 200 response with the data for the new object on success.