Create a deal

Creates a deal in a pipeline stage.

Endpoint

POST
/deals

Body

NameTypeRequiredDescription
organization_idintegerYesOrganization to create the deal in.
namestringYesDeal name.
pipeline_idintegerYesDeal pipeline. Must be visible to the key's user.
pipeline_stage_idintegerYesStage in that pipeline.
contact_idintegerYesContact of the deal.
amountnumberNoValue. Default 0. Overwritten when deal products change.
currency_idintegerNoCurrency. Fills the display fields and exchange_rate.
statusstringNoopen, won or lost.
company_idintegerNoLinked company.
owned_by_user_idintegerNoOwner.
expected_close_datestringNoISO 8601 date-time.
custom_fields_by_keyobjectNoCustom field values keyed by field key.
tagsarrayNo{ id } of the organization's deal tags.

Fields not in the deal object are rejected. created_by_user_id is set to the API key's user.

Request

Response

json

Creating a deal records its first stage in the stage history and triggers the organization's "deal created" automations.

Errors

StatusWhen
400 Bad RequestA required field is missing, an unknown field is sent, or a custom field value is invalid.
403 Forbiddenorganization_id is not accessible with your key, or pipeline_id is a private pipeline the key's user cannot see.

Report an issue with this documentation

Please log in to report issues with our documentation.