Skip to main content

Create deal

Creates a new deal by field structure (see. GetDealStructure)

Function CreateDeal(Val URL, Val FieldsStructure, Val Token = "") Export

ParameterCLI optionTypeDescription
URL--urlStringURL of webhook or a Bitrix24 domain, when token used
FieldsStructure--fieldsStructure of KeyAndValueDeal fields structure (see. GetDealStructure)
Token--tokenStringAccess token, when app auth method used

Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API


tip

Method at API documentation: crm.deal.add


Code example
    FieldsStructure = New Structure;
    FieldsStructure.Insert("TITLE"         , "Planned sale");
    FieldsStructure.Insert("TYPE_ID"       , "GOODS");
    FieldsStructure.Insert("STAGE_ID"      , "NEW");
    FieldsStructure.Insert("COMPANY_ID"    , 1);
    FieldsStructure.Insert("CONTACT_ID"    , 3);
    FieldsStructure.Insert("OPENED"        , "Y");
    FieldsStructure.Insert("ASSIGNED_BY_ID", 1);
    FieldsStructure.Insert("PROBABILITY"   , 30);
    FieldsStructure.Insert("CURRENCY_ID"   , "USD");
    FieldsStructure.Insert("OPPORTUNITY"   , 5000);
    FieldsStructure.Insert("CATEGORY_ID"   , 5);
    FieldsStructure.Insert("BEGINDATE"     , "2024-01-01");
    FieldsStructure.Insert("CLOSEDATE"     , "2030-01-01");

    URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";

    Result = OPI_Bitrix24.CreateDeal(URL, FieldsStructure);

    FieldsStructure.Insert("TITLE"    , "Another deal");
    FieldsStructure.Insert("CLOSEDATE", "2031-01-01");

    URL   = "b24-ar17wx.bitrix24.by";
    Token = "b529cb66006e9f06006b12e400000001000...";

    Result = OPI_Bitrix24.CreateDeal(URL, FieldsStructure, Token);
CLI command example
    
  oint bitrix24 CreateDeal --url "b24-ar17wx.bitrix24.by" --fields %fields% --token "6476c766006e9f06006b12e400000001000..."

Result
{
 "result": 74,
 "time": {
  "start": 1724584043.72863,
  "finish": 1724584043.94602,
  "duration": 0.21738600730896,
  "processing": 0.192203044891357,
  "date_start": "2024-08-25T11:07:23+00:00",
  "date_finish": "2024-08-25T11:07:23+00:00",
  "operating_reset_at": 1724584643,
  "operating": 0.192182064056396
 }
}