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.

Delete a deal property

Last updated June 17, 2020

DELETE /properties/v1/deals/properties/named/:property_name

Method Details

HTTP Methods:

DELETE

Response Format:

N/A

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM

Required Scope:

crm.schemas.deals.write

For an account, delete an existing deal property.

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 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?hapikey=demo

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.

  • 204 No Content - when a property is deleted
  • 401 Unauthorized - when an unauthorized request is made
  • 500 Internal Server Error - when an internal server error occurs.

Note This replaces the deprecated URL DELETE /deals/v1/properties/named/:property_name