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:
DELETE
Response Format:
N/A
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
CRM
crm.schemas.deals.write
For an account, delete an existing deal property.
| 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 (see above) | The API name of the property that you will be deleting |
| Optional Parameters | How to use | Description |
|---|---|---|
| None | None | No optional parameters for this method. |
Example URL to DELETE: https://api.hubapi.com/properties/v1/deals/properties/named/invoicenumber
If the request succeeds, you'll get an HTTP 204 response with no content in the response body, which represents that you've just deleted the property out of the system.
The response from this API call are standard REST-style HTTP response codes that mark success or failure, with meta information about the call that was made. There will be no data in the response body.
Note This replaces the deprecated URL DELETE /deals/v1/properties/named/:property_name
