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

Заменить клиентов брони

PUT /v1/bookings/:id/clients

Записывает клиентов брони переданным набором: клиенты, которых нет в запросе, снимаются с брони. Пустой массив clients снимает всех клиентов.

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID брони. Список: GET /v1/bookings

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

Поле Тип Обяз. Описание
clients array да Новый набор клиентов брони. Пустой массив снимает всех клиентов
clients[].id number да ID контакта или компании CRM. Списки: GET /v1/contacts, GET /v1/companies
clients[].type.module string да Модуль типа клиента: crm. Справочник: GET /v1/booking-client-types
clients[].type.code string да Код типа клиента: CONTACT — контакт, COMPANY — компания. Справочник: GET /v1/booking-client-types

Других полей тело не принимает: лишнее поле отвечает 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl -X PUT "https://vibecode.bitrix24.tech/v1/bookings/53/clients" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clients": [
      { "id": 3013, "type": { "module": "crm", "code": "CONTACT" } },
      { "id": 3149, "type": { "module": "crm", "code": "COMPANY" } }
    ]
  }'

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

Terminal 
curl -X PUT "https://vibecode.bitrix24.tech/v1/bookings/53/clients" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "clients": [
      { "id": 3013, "type": { "module": "crm", "code": "CONTACT" } },
      { "id": 3149, "type": { "module": "crm", "code": "COMPANY" } }
    ]
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bookings/53/clients', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    clients: [
      { id: 3013, type: { module: 'crm', code: 'CONTACT' } },
      { id: 3149, type: { module: 'crm', code: 'COMPANY' } },
    ],
  }),
})

const { success, data } = await res.json()
console.log('Клиенты брони:', data.map((client) => `${client.type.code} ${client.id}`))

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bookings/53/clients', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    clients: [
      { id: 3013, type: { module: 'crm', code: 'CONTACT' } },
      { id: 3149, type: { module: 'crm', code: 'COMPANY' } },
    ],
  }),
})

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

Поля ответа

В ответе — клиенты брони, заново прочитанные после записи.

Поле Тип Описание
success boolean true при успехе
data array Клиенты брони после замены. После пустого clients — пустой массив
data[].id number ID контакта или компании CRM. Получить: GET /v1/contacts/:id, GET /v1/companies/:id
data[].type.code string Код типа клиента: CONTACT — контакт, COMPANY — компания
data[].type.module string Модуль типа клиента: crm

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 3013,
      "type": {
        "code": "CONTACT",
        "module": "crm"
      }
    },
    {
      "id": 3149,
      "type": {
        "code": "COMPANY",
        "module": "crm"
      }
    }
  ]
}

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

400 — такого типа клиента нет в справочнике:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Client type not found"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Client type not found — пары type.module и type.code нет в справочнике типов. Клиенты брони не меняются
400 INVALID_PARAMS Each client requires id and type.module/type.code — у элемента clients нет id, type.module или type.code, либо id не целое положительное число
400 INVALID_PARAMS Only clients can be written — в теле есть поле, кроме clients
400 INVALID_PARAMS id must be a canonical positive safe integer — id брони не целое положительное число
400 MISSING_REQUIRED_FIELDS clients must be an array — в теле нет clients или это не массив
404 ENTITY_NOT_FOUND Booking record not found — брони с таким id нет
404 ENTITY_NOT_FOUND Контакта или компании с указанным clients[].id нет в CRM. Клиенты брони не меняются
401 MISSING_API_KEY Не передан X-Api-Key
401 TOKEN_MISSING У ключа нет токенов Битрикс24
403 WRITE_BLOCKED_READONLY_KEY Ключ работает в режиме только для чтения. Запрос отклоняется до обращения к порталу
403 SCOPE_DENIED У ключа нет скоупа booking
429 RATE_LIMITED Превышена частота запросов. Действующий потолок — в заголовке x-ratelimit-limit
502 BITRIX_RESPONSE_INVALID Bitrix24 did not confirm the booking operation — Битрикс24 не подтвердил запись
502 BITRIX_RESPONSE_INVALID Bitrix24 returned an unexpected booking response — Битрикс24 вернул список клиентов неожиданной формы

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

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