Update a deal

Last updated June 17, 2020

PUT /deals/v1/deal/:dealId

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM

Required Scope:

contacts

The update a deal endpoint updates an existing deal in HubSpot using the dealId and JSON-specified properties in the request body. 

What's a use case for this endpoint? You want to update a deal with a tracking number. To do this, you need to integrate HubSpot with your shipping software, which stores tracking numbers. Once the deal moves to a closed-won or shipping stage, the integration will use the update a deal endpoint to add a tracking number property to the deal.

Response details

This endpoint returns JSON representing the updated deal.

NOTE: Associations cannot be updated using this endpoint. You'll need to use the separate endpoint documented here.

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.
Deal Id Used in the request URL (see above) Unique identifier for a particular deal.
Deal JSON Used in the request body This is JSON that represents the changes that you are making to the specified deal. This should be in the format of the JSON example provided.
Optional Parameters How to use Description
None None No optional parameters for this method.