v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

Deals

Create a deal

post/crm/deals

Request body

namestring required

Name of deal

attributesobject

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}

linkedContactsIdsinteger[]

Contact ids to be linked with deal

linkedCompaniesIdsstring[]

Company ids to be linked with deal

Example request

{
  "name": "Deal: Connect with company",
  "attributes": {
    "deal_owner": "6093d2425a9b436e9519d034",
    "amount": 12
  },
  "linkedContactsIds": [
    1,
    2,
    3
  ],
  "linkedCompaniesIds": [
    "61a5ce58c5d4795761045990",
    "61a5ce58c5d4795761045991",
    "61a5ce58c5d4795761045992"
  ]
}

Response

Created new Deal

idstring required

Unique deal id

Example response

{
  "id": "61a5cd07ca1347c82306ad06"
}