Skip to main content
POST
/
extensions
/
sales-objects
/
v1
/
object-types
Create object type
curl --request POST \
  --url https://api.hubapi.com/extensions/sales-objects/v1/object-types \
  --header 'Content-Type: application/json' \
  --data '
{
  "applicationId": 123,
  "baseUris": [
    "<string>"
  ],
  "dataFetchUri": "<string>",
  "title": "<string>",
  "propertyDefinitions": [
    {
      "name": "<string>",
      "label": "<string>",
      "dataType": "STRING",
      "options": [
        {}
      ]
    }
  ],
  "associatedHubSpotObjectTypes": [
    "CONTACT"
  ],
  "associatedHubSpotObjectTypeProperties": {}
}
'
{
  "id": 123,
  "applicationId": 123,
  "baseUris": [
    "<string>"
  ],
  "dataFetchUri": "<string>",
  "title": "<string>",
  "propertyDefinitions": [
    {}
  ],
  "associatedHubSpotObjectTypes": [
    "<string>"
  ],
  "associatedHubSpotObjectTypeProperties": {}
}

Query Parameters

​
hapikey
string
required

Your Developer HAPIkey. This must be a Developer HAPIkey associated with the Developer portal that the OAuth app was created in.

Body

application/json
​
applicationId
integer
required

The ID of the HubSpot application that will own this object type.

​
baseUris
string[]
required

A list of URIs. When you define actions, the URIs for these actions must be under one of these URIs.

​
dataFetchUri
string
required

The URI the CRM will call to fetch Sales Objects for the specified associatedHubSpotObjectTypes.

​
title
string
required

The title of this object. This will be displayed as the title of the CRM sidebar card.

​
propertyDefinitions
object[]
required

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
enum<string>[]
required

A set of CONTACT, COMPANY, DEAL, or TICKET. This determines where on the CRM this Object Type will appear -- contact, company, deal, or ticket details pages.

Available options:
CONTACT,
COMPANY,
DEAL,
TICKET
​
associatedHubSpotObjectTypeProperties
object
required

HubSpot properties to send in the data fetch request, by CRM object type.

Response

201 - application/json

Successful response - Object type created successfully

​
id
integer
​
applicationId
integer
​
baseUris
string[]
​
dataFetchUri
string
​
title
string
​
propertyDefinitions
object[]
​
associatedHubSpotObjectTypes
string[]
​
associatedHubSpotObjectTypeProperties
object
Last modified on December 12, 2025