Create a Deal

POST /deals/v1/deal/

Method Details

HTTP Methods:


Content Type:


Response Format:


Requires Authentication?


Rate Limited?






For a given portal, create a deal. This is particularly useful if you're integrating with a CRM or another application that has a similar notion of a deal.

Note that you can create associations between Deals and Contacts and Companies much the same way you create an association between Companies and Contacts. Associating your Deal with Contacts and Companies is not required (i.e. you can create an orphaned deal). You can also pass any custom property value you want to the deals API, so long as you've created the property first.

The dealstage property is required when creating a deal. If the pipeline property is not specified, the default pipeline is assumed. However, it is recommended to always specify the pipeline, especially on portals with multiple pipelines. You can manage pipelines and dealstages through the Deals Pipelines API.

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 JSON Used in the request body This is JSON that represents a company that you're creating. This should be in the format of the code sample below.
Optional Parameters How to use Description
None None No optional parameters for this method.