There's a new version of the HubSpot API
We're also working on a new documentation website, you're invited to check it out and give us your feedback.
HTTP Methods:
PUT
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
CRM
crm.schemas.deals.write
Update the definition for the specified deal property.
Need to update your deal stage definitions or your pipeline definitions? The dealstage and pipeline properties are managed using the CRM Pipelines API.
| 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. |
| 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 the deal property you are updating. 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. 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:
|
| Optional Parameters | How to use | Description |
|---|---|---|
| None | None | No optional parameters for this method. |
Example URL to PUT: https://api.hubapi.com/properties/v1/deals/properties/named/invoiced
Note: Your "Content-Type" must be application/json.
Note This replaces the deprecated URL PUT /deals/v1/properties/named/:property_name
