There's a new version of the HubSpot API

Starting November 30, 2022, API keys will be sunset as an authentication method. Learn more about this change and how to migrate an API key integration to use a private app instead.

Create a deal property

Last updated June 17, 2020

POST /properties/v1/deals/properties/

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM

Required Scope:

crm.schemas.deals.write

Create a property on every deal object to store a specific piece of data. In the example below, we want to store an invoice number on a separate field on deals.

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.
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 POST to:  https://api.hubapi.com/properties/v1/deals/properties?hapikey=demo

Note: Your "Content-Type" must be application/json.

Note This replaces the deprecated URL POST /deals/v1/properties/