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.

Update an object property

Last updated June 17, 2020

PATCH /properties/v2/:object_type/properties/named/:property_name

Method Details

HTTP Methods:

PATCH

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

tickets
e-commerce

Update an existing property for the specified object. Only fields included will be updated. Any omitted fields will retain their current value. 
Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header or hapikey={key} query parameter. Used to authenticate the request. Please see this page for more details about authentication.
Object type

:object_type
Used in the request URL

The specific object that you want to update the property for. Must be one of:

  • tickets
  • products
  • line_items
Property name /:property_name
Used in the request URL		 The internal name of the property you want to update.
Property JSON Used in the request body.
See the example for details.		 This is JSON that represents the property being updated. See the example for details. Also note that there are a set number of field types that you can create. These pertain to the way that the property will appear in HubSpot. Field types are as follows:
  • textarea
  • select
  • text
  • date
  • file
  • number
  • radio
  • checkbox

Also, there are certain 'types' of data that you can have populate each of these fields - these are as follows:

  • string
  • number
  • bool
  • datetime
  • enumeration

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example PATCH URL (updating a ticket property): https://api.hubapi.com/properties/v2/tickets/properties/named/example_property?hapikey=demo Example PATCH JSON: { "label": "Example updated ticket property", "description": "This is a property that has an updated description" } Example Response: { "name": "example_property", "label": "Example updated ticket property", "description": "This is a property that has an updated description", "groupName": "ticketinformation", "type": "string", "fieldType": "text", "deleted": false, "createdAt": 1568733064656, "formField": true, "displayOrder": -1, "readOnlyValue": false, "readOnlyDefinition": false, "mutableDefinitionNotDeletable": false, "favorited": false, "favoritedOrder": -1, "calculated": false, "externalOptions": false, "displayMode": "current_value", "showCurrencySymbol": false, "hubspotDefined": null, "hidden": false, "updatedAt": 1568733064656, "referencedObjectType": null, "hasUniqueValue": false, "optionSortStrategy": null, "createdUserId": 100097, "searchableInGlobalSearch": false, "currencyPropertyName": null, "textDisplayHint": null, "numberDisplayHint": "formatted", "optionsAreMutable": null, "isCustomizedDefault": false, "searchTextAnalysisMode": null, "updatedUserId": 100097, "options": [] }