Create a deal

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Request

Deal create data.
namestringRequired
Name of deal
attributesobjectOptional

Attributes for deal creation To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you want to create a deal on a specific pipeline and stage you can use the following attributes pipeline and deal_stage. Pipeline and deal_stage are ids you can fetch using this endpoint /crm/pipeline/details/{pipelineID}

linkedCompaniesIdslist of stringsOptional
Company ids to be linked with deal
linkedContactsIdslist of longsOptional
Contact ids to be linked with deal

Response

Created new Deal
idstring
Unique deal id

Errors