Update deal

Modifies an existing deal

Parameters

Function UpdateDeal(Val URL, Val DealID, Val FieldsStructure, Val Token = "") Export

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
DealID	--deal	Number, String	✔	Deal ID
FieldsStructure	--fields	Structure Of KeyAndValue	✔	Deal fields structure
Token	--token	String	✖	Access token, when app auth method used

Returns

Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API

Advanced call ?

Parameter	Description
proxy	InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication
timeout	Request execution timeout
adv_response	Formats the response as a complete HTTP structure with fields code, body, and headers
retries	Number of HTTP request send attempts on 5** status codes or internal client errors
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

tip

Method at API documentation: crm.deal.update

1C:Enterprise/OneScript code example

    FieldsStructure = New Structure;
    FieldsStructure.Insert("TITLE"      , "Sale in RUB");
    FieldsStructure.Insert("CURRENCY_ID", "RUB");
    FieldsStructure.Insert("OPPORTUNITY", 50000);

    URL    = "https://b24-ar17wx.bitrix24.by/rest/1/av5...";
    DealID = "5482";

    Result = OPI_Bitrix24.UpdateDeal(URL, DealID, FieldsStructure);

    FieldsStructure.Insert("TITLE"    , "Future deal in RUB");
    FieldsStructure.Insert("BEGINDATE", "2025-01-01");

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "a5b00469006e9f06006b12e400000001000...";
    DealID = "5484";

    Result = OPI_Bitrix24.UpdateDeal(URL, DealID, FieldsStructure, Token);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint bitrix24 UpdateDeal \
      --url "b24-ar17wx.bitrix24.by" \
      --deal 7790 \
      --fields "{'TITLE':'Future deal in RUB','CURRENCY_ID':'RUB','OPPORTUNITY':'50000','BEGINDATE':'2025-01-01'}" \
      --token "***"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint bitrix24 UpdateDeal ^
      --url "b24-ar17wx.bitrix24.by" ^
      --deal 7790 ^
      --fields "{'TITLE':'Future deal in RUB','CURRENCY_ID':'RUB','OPPORTUNITY':'50000','BEGINDATE':'2025-01-01'}" ^
      --token "***"

Result

{
 "result": true,
 "time": {
  "start": 1781804803,
  "finish": 1781804804.05332,
  "duration": 1.05332493782043,
  "processing": 1,
  "date_start": "2026-06-18T17:46:43+00:00",
  "date_finish": "2026-06-18T17:46:44+00:00",
  "operating_reset_at": 1781805403,
  "operating": 0.188169002532959
 }
}