Create a New Custom Property (Field)

Last updated September 6, 2018

PUT /contacts/v1/properties/:property_name

Method Details

HTTP Methods:

PUT

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Both

Create a new property in HubSpot. Properties in HubSpot are fields that have been created. By default, there are many fields that come "out of the box" in a HubSpot portal, but users can also create new, custom properties as they please.

This method enables you to create a new property. If you try to create a property whose name already exists in the system, you'll get an HTTP 409 exception thrown from the API.

Currently, there is a 1,000 property limit that you can have in any given portal.

This v1 endpoint is deprecated. Please use the v2 endpoint:
http://developers.hubspot.com/docs/methods/contacts/v2/create_contacts_property

Required Parameters How to use Description
HubSpot API Key hapikey=X - Used in the request URL The HubSpot API key for the portal that you're making the call for.
Property Name Used in the request URL You must include the property name in the URL that you're using to make the request. This property name can only include lower case letters and numbers, and MUST start with a lower case letter. Also, the name of the property that you include in your URL here MUST be identical to the property name that you include in the JSON request body (seen below)
Property JSON Used in the request body (see below) This is JSON that represents a new property that you're creating. This should be in JSON format - seen below in the code sample given. Also note that there are a set number of field types that you can create. These pertain to the form fields that you use in your forms to convert new contacts. 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
Optional Parameters How to use Description
None None No optional parameters for this method.

Example URL to PUT to: https://api.hubapi.com/contacts/v1/properties/newcustomproperty?hapikey=demo

Please Note The content type header that you use in your request should be 'application/json'.