For AI agents: markdown of this page — /docs-content-en/entities/leads/update.md documentation index — /llms.txt

Update lead

PATCH /v1/leads/:id

Updates the fields of an existing lead. Pass only the fields you want to change. See the full list in the field reference.

⚠ Important about email / phone (multifield): On update, Bitrix24 only adds new multifield records. PATCH {"email": "new@y.com"} on a lead that already has an email will not replace the old one — the lead will end up with two emails. This is Bitrix24-specific behavior, not Vibecode. To replace or remove email/phone — edit the lead through the Bitrix24 UI. An object with an id field (an attempt to update or delete a single row) is not accepted by this PATCH: 400 MULTIFIELD_ID_NOT_SUPPORTED, and nothing is written.

Frequently updated fields

Parameter Type Description
stageId string Lead status — canonical name, the statusId alias is also accepted. List: GET /v1/statuses?filter[entityId]=STATUS. In the response the value is returned in the stageId field
opportunity number Amount — canonical name, the amount alias is also accepted. ⚠ For the value to persist, pass isManualOpportunity: true in the same request
assignedById number Assignee. List: GET /v1/users
title string Lead title
phone string | string[] | object[] Phone. Accepts three forms: a string "+1...", an array of strings ["+1...", "+1..."], or an array of objects [{ "value": "+1...", "typeId": "WORK" }, …]. typeId: WORK | HOME | MOBILE | OTHER (default WORK). ⚠ The UPPER form [{ "VALUE": "...", "VALUE_TYPE": "WORK" }] is not accepted — it returns 400 INVALID_MULTIFIELD_SHAPE. Use camelCase: [{ "value": "...", "typeId": "WORK" }]
email string | string[] | object[] Email. Accepts three forms: a string "a@b.com", an array of strings ["a@b.com", "b@c.com"], or an array of objects [{ "value": "a@b.com", "typeId": "WORK" }, …]. typeId: WORK | HOME | MAILING | OTHER (default WORK). ⚠ The UPPER form [{ "VALUE": "...", "VALUE_TYPE": "WORK" }] is not accepted — it returns 400 INVALID_MULTIFIELD_SHAPE. Use camelCase: [{ "value": "...", "typeId": "WORK" }]
ufCrm* per field schema A user field of the Bitrix24 account, for example ufCrmProjectCode. The actual name and type are in the schema GET /v1/leads/fields, and the value format for each type is in User fields (UF). An enumeration field takes the option ID from the field's items array in the schema, and a multiple field takes an array of such IDs. If you send the option label VALUE instead of the ID, the value is lost: a single-value field gets 0. A number that is not among the options is stored as is. Neither the label nor a non-existent ID raises an error, and the request returns 200, so map the label to its ID on your side and check the stored value of this field in the response data

Examples

curl — personal key

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/v1/leads/42" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "stageId": "IN_PROCESS",
    "opportunity": 2500,
    "isManualOpportunity": true,
    "assignedById": 3,
    "title": "Website request — hot lead"
  }'

curl — OAuth application

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/v1/leads/42" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "stageId": "IN_PROCESS",
    "opportunity": 2500,
    "isManualOpportunity": true,
    "assignedById": 3,
    "title": "Website request — hot lead"
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/leads/42', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    stageId: 'IN_PROCESS',
    opportunity: 2500,
    isManualOpportunity: true,
    assignedById: 3,
    title: 'Website request — hot lead',
  }),
})

const { success, data } = await res.json()

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/leads/42', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    stageId: 'IN_PROCESS',
    opportunity: 2500,
    isManualOpportunity: true,
    assignedById: 3,
    title: 'Website request — hot lead',
  }),
})

const { success, data } = await res.json()

Alternative form — array of objects with explicit `typeId`

If you need to specify multiple values or an explicit type (HOME, MOBILE):

JSON 
{
  "phone": [
    { "value": "+12025550123", "typeId": "WORK" },
    { "value": "+12025550124", "typeId": "MOBILE" }
  ],
  "email": [
    { "value": "work@example.com", "typeId": "WORK" },
    { "value": "personal@example.com", "typeId": "HOME" }
  ]
}

Response fields

Field Type Description
data object The updated lead object with all fields — see Fields

The updated lead object — see Lead fields.

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 42,
    "title": "Website request",
    "stageId": "IN_PROCESS",
    "assignedById": 1,
    "createdTime": "2026-04-15T12:00:00+00:00",
    "updatedTime": "2026-04-15T13:00:00+00:00"
  }
}

Error response example

404 — lead not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Item not found"
  }
}

Errors

HTTP Code Description
404 ENTITY_NOT_FOUND Lead not found
422 STAGE_NOT_APPLIED The stageId/statusId that was sent was not applied — after the PATCH the status was still the old one (usually a value absent from the dictionary). Such a call used to answer 200 with no warning; now it is an explicit error: details in error.message and error.details, the re-read lead in data. The record has already been changed and the other fields of the body may have been applied: correct the value and send only what still needs changing, not the whole body again
403 ACCESS_DENIED No access
400 INVALID_MULTIFIELD_SHAPE Wrong shape for phone or email — expects [{ "value", "typeId" }]
400 MULTIFIELD_ID_NOT_SUPPORTED phone, email or the raw fm[] contains an object with an id field. Bitrix24 neither updates nor deletes a single multifield row through this call — it would append a duplicate — so the request is refused and nothing is written
400 READONLY_FIELD Attempt to write a read-only field
403 SCOPE_DENIED The API key does not have the crm scope
401 TOKEN_MISSING The API key has no configured tokens

Full list of common API errors — Errors.

See also