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

Переименовать ресурс календаря

PATCH /v1/calendar-resources/:id

Меняет название ресурса календаря.

Параметры

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

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

Поле Тип Обяз. Описание
name string да Новое название ресурса. Другие поля в теле отклоняются с 400 READONLY_FIELD

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/calendar-resources/285" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Переговорная 2, третий этаж"}'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/calendar-resources/285" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Переговорная 2, третий этаж"}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/calendar-resources/285', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Переговорная 2, третий этаж' }),
})

const { success, data } = await res.json()
console.log('Новое название:', data.name)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/calendar-resources/285', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Переговорная 2, третий этаж' }),
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Ресурс после изменения. Его поля — строками data.* ниже
data.id number ID ресурса
data.name string Название ресурса после изменения
data.createdBy number ID сотрудника, создавшего ресурс. Список: GET /v1/users

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

JSON 
{
  "success": true,
  "data": {
    "id": 285,
    "name": "Переговорная 2, третий этаж",
    "createdBy": 1295
  }
}

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

404 — ресурса с таким ID нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Calendar record not found"
  }
}

Ошибки

HTTP Код Описание
400 MISSING_REQUIRED_FIELDS Не передан name или передана пустая строка
400 READONLY_FIELD В теле есть поля, кроме name
400 INVALID_PARAMS id — не положительное целое число
404 ENTITY_NOT_FOUND Ресурса с таким id нет в списке ресурсов
422 BITRIX_ERROR Битрикс24 не подтвердил переименование или не сохранил новое название
403 WRITE_BLOCKED_READONLY_KEY API-ключ в режиме только чтения — запись запрещена
403 SCOPE_DENIED API-ключ не имеет скоупа calendar
403 BITRIX_ACCESS_DENIED Битрикс24 отказал владельцу ключа в изменении ресурса
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
401 MISSING_API_KEY Не передан заголовок X-Api-Key
429 RATE_LIMITED Превышен лимит запросов
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул список ресурсов неверной формы
503 BITRIX_TIMEOUT Битрикс24 не ответил вовремя

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

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

Пакетом не переименовать. POST /v1/calendar-resources/batch с действием update отклоняется с 400 ACTION_NOT_SUPPORTED. Каждый ресурс переименовывайте отдельным вызовом этого метода.

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