POST /crm/deals

Options

Body

Deal create data.

Request body which must comply to the following JSON Schema:

{
  "required" : [ "name" ],
  "type" : "object",
  "properties" : {
    "name" : {
      "type" : "string",
      "description" : "Name of deal",
      "example" : "Deal: Connect with company"
    },
    "attributes" : {
      "type" : "object",
      "description" : "Attributes for deal creation\n\nTo assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID.\n\nIf you want to create a deal on a specific pipeline and stage you can use the following attributes `pipeline` and `deal_stage`.\n\nPipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}`\n",
      "example" : {
        "deal_owner" : "6093d2425a9b436e9519d034",
        "amount" : 12
      }
    },
    "linkedContactsIds" : {
      "type" : "array",
      "description" : "Contact ids to be linked with deal",
      "example" : [ 1, 2, 3 ],
      "items" : {
        "type" : "integer",
        "format" : "int64"
      }
    },
    "linkedCompaniesIds" : {
      "type" : "array",
      "description" : "Company ids to be linked with deal",
      "example" : [ "61a5ce58c5d4795761045990", "61a5ce58c5d4795761045991", "61a5ce58c5d4795761045992" ],
      "items" : {
        "type" : "string",
        "format" : "objectID"
      }
    }
  }
}

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers