Method Details
HTTP Methods:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing & CRM
tickets
e-commerce
There's a new version of the HubSpot API
As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.
HTTP Methods:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing & CRM
tickets
e-commerce
| Required Parameters | How to use | Description |
|---|---|---|
| OAuth access token or private app access token | Authorization: Bearer {token} header | Used to authenticate the request. Please see this page for more details about authentication. |
| Object type |
:object_type |
The specific object that you want to create a new property for. Must be one of:
|
| Property JSON | Used in the request body. See the example for details. |
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:
Also, there are certain 'types' of data that you can have populate each of these fields - these are as follows:
|