#Update contact

PATCH /v1/contacts/:id

Updates fields of an existing contact. Pass only the fields you want to change. Full list in the field reference, including user fields (ufCrm_*).

⚠ Important about email / phone (multifield): Bitrix24 in crm.item.update only adds new multifield records. PATCH {"email": "new@y.com"} to a contact that already has an email will not replace the old one — the contact will end up with two emails. This is a B24 specific, not VibeCode. To replace or remove an email/phone — edit the contact via the Bitrix24 UI.

#Frequently updated fields

Parameter Type Description
phone string | string[] | object[] Phone. Accepts three forms: a string "+7...", an array of strings ["+7...", "+7..."], or an array of objects [{ "value": "+7...", "typeId": "WORK" }, …]. typeId: WORK | HOME | MOBILE | OTHER (default WORK). ⚠ The B24-native 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 B24-native UPPER form [{ "VALUE": "...", "VALUE_TYPE": "WORK" }] is not accepted — it returns 400 INVALID_MULTIFIELD_SHAPE. Use camelCase: [{ "value": "...", "typeId": "WORK" }]
companyId number Company ID. Lookup: GET /v1/companies
assignedById number Assigned user. List: GET /v1/users
post string Position

#Examples

#curl — personal key

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/contacts/71" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+79169876543",
    "post": "Director"
  }'

#curl — OAuth app

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/contacts/71" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+79169876543",
    "post": "Director"
  }'

#JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/contacts/71', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    phone: '+79169876543',
    post: 'Director',
  }),
})

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

#JavaScript — OAuth app

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/contacts/71', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    phone: '+79169876543',
    post: 'Director',
  }),
})

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": "+79161234567", "typeId": "WORK" },
    { "value": "+79161112233", "typeId": "MOBILE" }
  ],
  "email": [
    { "value": "work@company.ru", "typeId": "WORK" },
    { "value": "personal@me.ru", "typeId": "HOME" }
  ]
}

#Response fields

Field Type Description
data object Updated contact object with all fields — see Fields

The updated contact object — see Contact fields.

#Response example

JSON 
{
  "success": true,
  "data": {
    "id": 71,
    "name": "Ivan",
    "lastName": "Petrov",
    "companyId": 15,
    "assignedById": 1,
    "createdTime": "2020-05-08T10:48:20+03:00",
    "updatedTime": "2026-04-15T12:00:00+03:00"
  }
}

#Error response example

404 — contact not found:

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

#Errors

HTTP Code Description
404 ENTITY_NOT_FOUND Contact not found
403 ACCESS_DENIED No access
400 INVALID_REQUEST Invalid fields
403 SCOPE_DENIED API key lacks the crm scope
401 TOKEN_MISSING API key has no configured tokens

Full list of common API errors — Errors.

#See also