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

PATCH /v1/openline-configs/:id

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

#Параметры

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

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

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

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

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

#Примеры

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

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-приложение

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 — личный ключ

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-приложение

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": true,
  "data": {
    "id": 29,
    "updated": true
  }
}

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

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

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

#Ошибки

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

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

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

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

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

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

• Получить конфигурацию — текущие значения полей
• Поля конфигурации — полный список изменяемых полей
• Список конфигураций — все конфигурации на портале
• Batch — массовое обновление записей