#Create Open Channel configuration

POST /v1/openline-configs

Creates a new Open Channel configuration. At least one recognised writable field is enough to create one — the remaining parameters take their default values. The full record with identifiers and all fields is available via GET /v1/openline-configs/:id.

#Request fields (body)

Minimum to create: at least one recognised writable field (see Configuration fields).

Field names. Pass every field in camelCase (name, active, queueType, crmCreate, workTimeFrom, etc. — see Configuration fields) — the canonical case, as it appears in responses and in GET /v1/openline-configs/fields. B24-native UPPER_SNAKE_CASE names are also accepted for backward compatibility and mapped to the right Bitrix24 name automatically. The example below uses camelCase.

Boolean fields (active, crm, workTimeEnable, welcomeMessage, …) accept true / false — the value is coerced to Bitrix24's expected "Y"/"N" automatically.

Full field list — GET /v1/openline-configs/fields.

#Examples

#curl — personal key

curl -X POST https://vibecode.bitrix24.com/v1/openline-configs \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer support",
    "active": true,
    "queueType": "evenly",
    "workTimeEnable": true,
    "workTimeFrom": "9",
    "workTimeTo": "18"
  }'

#curl — OAuth application

curl -X POST https://vibecode.bitrix24.com/v1/openline-configs \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer support",
    "active": true,
    "queueType": "evenly",
    "workTimeEnable": true,
    "workTimeFrom": "9",
    "workTimeTo": "18"
  }'

#JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/openline-configs', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Customer support',
    active: true,
    queueType: 'evenly',
    workTimeEnable: true,
    workTimeFrom: '9',
    workTimeTo: '18',
  }),
})

const { success, data } = await res.json()
console.log('New configuration ID:', data)

#JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/openline-configs', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Customer support',
    active: true,
    queueType: 'evenly',
    workTimeEnable: true,
    workTimeFrom: '9',
    workTimeTo: '18',
  }),
})

const { success, data } = await res.json()
console.log('New configuration ID:', data)

#Response fields

#Response example

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

#Error response example

400 — the body has no recognised field:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "No recognised openline-configs field in the body. Unrecognised: bogusField. Provide at least one known field (e.g. lineName, queueType, active) — see GET /v1/openline-configs/fields."
  }
}

#Errors

Full list of common API errors — Errors.

#Known specifics

data in the response is a number (the identifier of the new configuration), not a record object. To get the created configuration with all fields, make a separate request: GET /v1/openline-configs/:id.

Unrecognised fields. Bitrix24 silently ignores unknown keys of the imopenlines.config.add method. The wrapper checks the body against the full field schema (Configuration fields) and reacts as follows:

• no field is recognised (e.g. { "bogusField": "x" }) — 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 configuration is created, and the response carries meta.warnings with the list of ignored keys.
• 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
• List configurations
• Configuration fields