Update an object property

Last updated September 17, 2019

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:

contacts

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