Create a Deal

Create a new deal in your organization.

Endpoint

POST
/deals

Request

Loading editor...

Response

json
Loading editor...

Request Parameters

ParameterTypeRequiredDescription
organization_idNumberYesID of the organization to create the deal in
nameStringYesName of the deal
amountNumberYesThe monetary value of the deal
currencyStringYesThe currency code (e.g., "USD", "EUR")
statusStringYesDeal status ('open', 'won', 'lost')
pipeline_idNumberYesID of the pipeline this deal belongs to
pipeline_stage_idNumberYesID of the pipeline stage this deal is currently in
contact_idNumberNoID of the contact associated with this deal
company_idNumberNoID of the company associated with this deal
owned_by_user_idNumberNoID of the user who owns this deal (defaults to creator)
expected_close_dateStringNoExpected date of deal closure (ISO 8601 format)

Report an issue with this documentation

Please log in to report issues with our documentation.