Значения полей CRM и основной контакт

Изменяйте одно значение без замены всего списка или выбирайте основной контакт из уже привязанных.

Битрикс24 API: crm.<entity>.addfieldvalue, crm.<entity>.deletefieldvalue, crm.<entity>.setprimarycontact Скоуп: crm

Операции требуют включённого флага crm-rest-v3 и обновления Битрикс24 после crm 26.2200.0 с включённой возможностью RestV3CrudDeal. До включения API возвращает 422 METHOD_NOT_YET_AVAILABLE с error.release.

Добавить одно значение поля CRM

POST /v1/deals/:id/fields/:field/values

POST /v1/leads/:id/fields/:field/values

POST /v1/contacts/:id/fields/:field/values

POST /v1/companies/:id/fields/:field/values

POST /v1/quotes/:id/fields/:field/values

POST /v1/invoices/:id/fields/:field/values

POST /v1/items/:entityTypeId/:id/fields/:field/values

Добавляет одно значение в множественное поле.

Операции требуют включённого флага crm-rest-v3 и обновления Битрикс24 после crm 26.2200.0 с включённой возможностью RestV3CrudDeal. До включения API возвращает 422 METHOD_NOT_YET_AVAILABLE с error.release.

Требуется скоуп crm и право записи READWRITE. Ресурсы и форматы значений.

Параметры

Поля запроса (body)

Примеры

curl — личный ключ

curl -i -X POST "https://vibecode.bitrix24.tech/v1/contacts/12/fields/email/values" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":{"valueTypeId":"WORK","value":"vibe-probe@example.com"}}'

curl — OAuth-приложение

curl -i -X POST "https://vibecode.bitrix24.tech/v1/contacts/12/fields/email/values" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"value":{"valueTypeId":"WORK","value":"vibe-probe@example.com"}}'

JavaScript — личный ключ

const res = await fetch('https://vibecode.bitrix24.tech/v1/contacts/12/fields/email/values', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({"value": {"valueTypeId": "WORK", "value": "vibe-probe@example.com"}})
})
console.log(res.status === 204)

JavaScript — OAuth-приложение

const res = await fetch('https://vibecode.bitrix24.tech/v1/contacts/12/fields/email/values', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_APP_KEY', 'Content-Type': 'application/json', 'Authorization': 'Bearer USER_SESSION_TOKEN' },
  body: JSON.stringify({"value": {"valueTypeId": "WORK", "value": "vibe-probe@example.com"}})
})
console.log(res.status === 204)

Поля ответа

Успех — HTTP 204 No Content с пустым телом. Проверяйте статус, не разбирайте JSON.

Пример ответа

HTTP/1.1 204 No Content

Пример ответа при ошибке

400 — поле тела не передано.

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Body must contain only value"
  }
}

Ошибки

Отказы Битрикс24 проходят общую обработку ошибок V1; сообщения очищаются от секретов. Общие ошибки.

Смотрите также

• Значения полей CRM и основной контакт