Modify an object type

There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API Keys are being deprecated and are no longer supported. Continued use of HubSpot API Keys is a security risk to your account and data. Your API Keys could be deactivated at any time after Nov. 30th, and we recommend that you migrate to Private Apps as soon as possible so you do not lose business-critical functionality.

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

Developer Tools

Required Scope:

integration-sync

Update the details for an existing object type. See creating an object type or the overview page for details on the required fields.

Note: The entire JSON structure for the object type must be provided in the request body. Anything not proviuded in the request body will be removed from the 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 type id	:object-type-id used in the request URL	The id of the object type you want to update.
Object details	Used in the request body	The JSON representing the details for the object type.See creating an object type or the overview page for details on the required fields.

Returns a 200 response with the JSON for the updated object on success.

JSON

Example PUT URL: https://api.hubapi.com/extensions/sales-objects/v1/object-types/678?hapikey= Example PUT data: { "id": 678, "applicationId": 12345, "baseUris": [ "https://example.com/actions" ], "dataFetchUri": "https://example.com/demo-tickets", "title": "DemoTickets", "propertyDefinitions": [ { "name": "ticket_type", "label": "Ticket type", "dataType": "STRING" }, { "name": "priority_updated", "label": "Priority (Updated)", "dataType": "STRING" }, { "name": "project", "label": "Project", "dataType": "STRING" }, { "name": "new_property", "label": "New Property", "dataType": "STRING" } ], "associatedHubSpotObjectTypes": [ "COMPANY" ], "associatedHubSpotObjectTypeProperties": { "COMPANY": [ "domain" ] } } Example Response: { "id": 678, "applicationId": 12345, "baseUris": [ "https://example.com/actions" ], "dataFetchUri": "https://example.com/demo-tickets", "title": "DemoTickets", "propertyDefinitions": [ { "name": "ticket_type", "label": "Ticket type", "dataType": "STRING" }, { "name": "priority_updated", "label": "Priority (Updated)", "dataType": "STRING" }, { "name": "project", "label": "Project", "dataType": "STRING" }, { "name": "new_property", "label": "New Property", "dataType": "STRING" } ], "associatedHubSpotObjectTypes": [ "COMPANY" ], "associatedHubSpotObjectTypeProperties": { "COMPANY": [ "domain" ] } }