Update Open Channel configuration

PATCH /v1/openline-configs/:id

Updates fields of an existing Open Channel configuration. Pass only the fields you change — the rest are left untouched. Full field list — Configuration fields.

Parameters

Request fields (body)

The request body must not be empty — at least one field is required. Pass only the fields you want to change.

Field names. Pass every field in camelCase (name, active, queueType, queueTime, workTimeFrom, etc.) — the canonical case. UPPER_SNAKE_CASE names are also accepted for backward compatibility.

Boolean fields (active, …) accept true / false — the value is coerced to "Y"/"N" automatically. For example, { "active": false } (or { "ACTIVE": false }) turns the channel off.

Full list of available fields — Configuration fields.

Examples

curl — personal key

curl -X PATCH "https://vibecode.bitrix24.com/v1/openline-configs/29" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "queueTime": 120,
    "welcomeMessageText": "Hello! How can we help?"
  }'

curl — OAuth application

curl -X PATCH "https://vibecode.bitrix24.com/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": "Hello! How can we help?"
  }'

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/openline-configs/29', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    queueTime: 120,
    welcomeMessageText: 'Hello! How can we help?',
  }),
})

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

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/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: 'Hello! How can we help?',
  }),
})

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

Response fields

Response example

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

Error response example

404 — configuration not found:

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

Errors

Full list of common API errors — Errors.

Known specifics

The response contains only id and data.updated: true — there are no configuration fields in the response. To get the current values of all fields after the update, call GET /v1/openline-configs/:id.

Request body validation. Unknown keys in the request body are not saved. Vibecode checks the body against the full field schema (Configuration fields) and reacts as follows:

• no field is recognised — the request is rejected with 400 VALIDATION_ERROR before the Bitrix24 call, and the message lists the unrecognised fields.
• at least one field is recognised but some keys are unknown — the update is applied, and the response carries meta.warnings with the list of ignored keys.
• crmCreate has a value other than none, lead, or deal — the whole body is rejected with 400 VALIDATION_ERROR before Bitrix24 is called, and no submitted change is applied.
• a read-only field (id, queue, dateCreate, and others) is passed in the body — the request is rejected with 400 READONLY_FIELD.

See also

• Get configuration
• Configuration fields
• List configurations
• Batch