Update lead

Modifies an existing lead

Function UpdateLead(Val URL, Val LeadID, Val FieldsStructure, Val Token = "") Export

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

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

tip

Method at API documentation: crm.lead.update

1C:Enterprise/OneScript code example

    FieldsStructure = New Structure;
    FieldsStructure.Insert("ADDRESS"        , "Lermontov st., b. 20");
    FieldsStructure.Insert("ADDRESS_COUNTRY", "Belarus");
    FieldsStructure.Insert("TITLE"          , "SuperClient");

    URL    = "https://b24-ar17wx.bitrix24.by/rest/1/h0m...";
    LeadID = "2416";

    Result = OPI_Bitrix24.UpdateLead(URL, LeadID, FieldsStructure);

    FieldsStructure.Insert("NAME"     , "Evgeniy");
    FieldsStructure.Insert("LAST_NAME", "Evgeniev");

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "75d8c668006e9f06006b12e400000001000...";
    LeadID = "2418";

    Result = OPI_Bitrix24.UpdateLead(URL, LeadID, FieldsStructure, Token);

Bash

    oint bitrix24 UpdateLead \
     --url ""b24-ar17wx.bitrix24.by"" \
     --lead "2458" \
     --fields ""/tmp/qzuicnbx.fi0.json"" \
     --token "***"

CMD/Bat

    oint bitrix24 UpdateLead ^
     --url ""b24-ar17wx.bitrix24.by"" ^
     --lead "2458" ^
     --fields ""/tmp/qzuicnbx.fi0.json"" ^
     --token "***"

Result

{
 "result": true,
 "time": {
  "start": 1757977054.17028,
  "finish": 1757977054.34192,
  "duration": 0.171638965606689,
  "processing": 0.14135217666626,
  "date_start": "2025-09-15T22:57:34+00:00",
  "date_finish": "2025-09-15T22:57:34+00:00",
  "operating_reset_at": 1757977654,
  "operating": 0.141335010528564
 }
}