Skip to main content

Update lead

Modifies an existing lead

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

ParameterCLI optionTypeRequiredDescription
URL--urlString✔URL of webhook or a Bitrix24 domain, when token used
LeadID--leadNumber, String✔Lead ID
FieldsStructure--fieldsStructure Of KeyAndValue✔Structure of lead fields
Token--tokenString✖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 = "2706";

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

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

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "53100369006e9f06006b12e400000001000...";
    LeadID = "2708";

    Result = OPI_Bitrix24.UpdateLead(URL, LeadID, FieldsStructure, Token);
    # JSON data can also be passed as a path to a .json file
    
    oint bitrix24 UpdateLead \
     --url "b24-ar17wx.bitrix24.by" \
     --lead 2728 \
     --fields "{'ADDRESS':'Lermontov st., b. 20','ADDRESS_COUNTRY':'Belarus','TITLE':'SuperClient','NAME':'Evgeniy','LAST_NAME':'Evgeniev'}" \
     --token "***"
Result
{
 "result": true,
 "time": {
  "start": 1761911941,
  "finish": 1761911941.88646,
  "duration": 0.886456966400146,
  "processing": 0,
  "date_start": "2025-10-31T11:59:01+00:00",
  "date_finish": "2025-10-31T11:59:01+00:00",
  "operating_reset_at": 1761912541,
  "operating": 0.252649068832397
 }
}