Для AI-агентов: markdown этой страницы — /docs-content/openlines/config/update.md индекс документации — /llms.txt

Обновить конфигурацию открытой линии

PATCH /v1/openline-configs/:id

Обновляет поля существующей конфигурации открытой линии. Передайте только изменяемые поля — остальные не затрагиваются. Полный список полей — Поля конфигурации.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеЧисловой идентификатор конфигурации

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

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

Имена полей. Все поля передавайте в camelCase — name, active, queueType, queueTime, workTimeFrom и другие. Это канонический регистр. Имена в UPPER_SNAKE_CASE также принимаются для обратной совместимости.

Булевы поля (active, …) принимают true / false — значение приводится к "Y"/"N" автоматически. Например, { "active": false } (или { "ACTIVE": false }) выключит линию.

Поле Тип Описание
Полеname Типstring ОписаниеНазвание открытой линии
Полеactive Типboolean ОписаниеВключена ли линия (true / false)
ПолеcrmCreate Типstring ОписаниеТип создаваемой CRM-записи при первом обращении. Допустимые значения: none, lead, deal
ПолеqueueTime Типnumber ОписаниеВремя ожидания ответа оператора (секунды)
ПолеnoAnswerTime Типnumber ОписаниеВремя до сработывания правила «Нет ответа» (секунды)
ПолеwelcomeMessageText Типstring ОписаниеТекст приветственного сообщения
ПолеworkTimeFrom Типstring ОписаниеНачало рабочего времени, например "9" или "9.30"
ПолеworkTimeTo Типstring ОписаниеКонец рабочего времени, например "18" или "17.30"
ПолеworkTimeTimezone Типstring ОписаниеЧасовой пояс рабочего времени

Полный список доступных полей — Поля конфигурации.

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/openline-configs/29" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "queueTime": 120,
    "welcomeMessageText": "Здравствуйте! Чем можем помочь?"
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/openline-configs/29" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "queueTime": 120,
    "welcomeMessageText": "Здравствуйте! Чем можем помочь?"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/openline-configs/29', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    queueTime: 120,
    welcomeMessageText: 'Здравствуйте! Чем можем помочь?',
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/openline-configs/29', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    queueTime: 120,
    welcomeMessageText: 'Здравствуйте! Чем можем помочь?',
  }),
})

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеРезультат операции
Полеdata.id Типnumber ОписаниеИдентификатор обновлённой конфигурации
Полеdata.updated Типboolean Описаниеtrue — обновление применено
Полеmeta.warnings Типstring[] ОписаниеНеобязательное. Присутствует, если часть переданных полей не распознана — перечисляет ключи, которые Битрикс24 проигнорировал

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

JSON 
{
  "success": true,
  "data": {
    "id": 29,
    "updated": true
  }
}

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

404 — конфигурация не найдена:

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

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_ID ОписаниеПараметр id не является положительным целым числом
HTTP400 КодVALIDATION_ERROR ОписаниеТело запроса пустое — необходимо передать хотя бы одно поле
HTTP400 КодVALIDATION_ERROR ОписаниеВ теле нет ни одного распознанного поля (все ключи неизвестны) — в сообщении перечислены нераспознанные поля
HTTP400 КодVALIDATION_ERROR ОписаниеДля crmCreate передано значение вне none, lead, deal
HTTP400 КодREADONLY_FIELD ОписаниеВ теле передано поле только для чтения (id, queue, dateCreate и другие)
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа imopenlines
HTTP404 КодENTITY_NOT_FOUND ОписаниеКонфигурация с указанным id не существует

Полный список общих ошибок API — Ошибки.

Известные особенности

Ответ содержит только id и data.updated: true — полей конфигурации в ответе нет. Чтобы получить актуальные значения всех полей после обновления, выполните GET /v1/openline-configs/:id.

Проверка тела запроса. Незнакомые ключи в теле запроса не сохраняются. Вайбкод сверяет тело с полной схемой полей (Поля конфигурации) и реагирует так:

  • ни одно поле не распознано — запрос отклоняется с 400 VALIDATION_ERROR до вызова Битрикс24, в сообщении перечислены нераспознанные поля.
  • распознано хотя бы одно поле, но часть ключей неизвестна — обновление применяется, а в ответе возвращается meta.warnings со списком проигнорированных ключей.
  • для crmCreate передано значение вне none, lead, deal — всё тело запроса отклоняется с 400 VALIDATION_ERROR до вызова Битрикс24, ни одно переданное изменение не применяется.
  • в теле передано поле только для чтения (id, queue, dateCreate и другие) — запрос отклоняется с 400 READONLY_FIELD.

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