POST /crm/deals

Create a deal

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
attributes Object No

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}

name String Yes

Name of deal

linkedContactsIds[] Array No

Contact ids to be linked with deal

linkedCompaniesIds[] Array No

Company ids to be linked with deal

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.