Изменить API-ключ

PATCH /v1/keys/:id

Изменяет настройки API-ключа владельца менеджмент-ключа. Тело плоское, без обёртки fields: передавайте только поля, которые меняются.

Параметры

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

Примеры

Запрос принимает только менеджмент-ключ — см. Ограничения.

curl — менеджмент-ключ

curl -X PATCH "https://vibecode.bitrix24.tech/v1/keys/6dbad0ce-79a9-43f5-8ca4-3e1af7ef63bc" \
  -H "X-Api-Key: YOUR_MANAGEMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Интеграция с CRM и задачами"
  }'

JavaScript — менеджмент-ключ

const res = await fetch('https://vibecode.bitrix24.tech/v1/keys/6dbad0ce-79a9-43f5-8ca4-3e1af7ef63bc', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_MANAGEMENT_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Интеграция с CRM и задачами',
  }),
})

const { success, data } = await res.json()
console.log('Ключ:', data.name, '—', data.status)

Поля ответа

Поля b24Ready в ответе нет. Узнать его можно запросом GET /v1/keys/:id.

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

{
  "success": true,
  "data": {
    "id": "6dbad0ce-79a9-43f5-8ca4-3e1af7ef63bc",
    "name": "Интеграция с CRM и задачами",
    "prefix": "vibe_api_XXXXXXXXX",
    "suffix": "XXXX",
    "type": "APP",
    "userId": "fafa9780-eed7-4d29-b040-2448d924f452",
    "portalId": "0d9f7744-f853-47c7-b06e-6f61f9dd1b7f",
    "clientId": null,
    "scopes": ["crm", "task", "tasks", "im"],
    "ipWhitelist": [],
    "expiresAt": null,
    "rateLimit": null,
    "status": "ACTIVE",
    "lastUsedAt": "2026-10-28T13:11:06.013Z",
    "createdAt": "2026-05-18T10:22:10.950Z",
    "updatedAt": "2026-10-29T12:16:49.962Z",
    "accessMode": "READWRITE",
    "totalDefault": null,
    "issuedVia": null
  }
}

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

403 — ключу авторизации приложения добавляется право Битрикс24:

{
  "success": false,
  "error": {
    "code": "OAUTH_SCOPE_CHANGE_REQUIRES_REISSUE",
    "message": "Набор прав OAuth-приложения нельзя изменить у существующего ключа — права фиксируются при выдаче. Создайте новый ключ авторизации с нужным набором прав."
  }
}

Ошибки

Отказы OWNER_DELETED, OWNER_BLOCKED и ACCOUNT_PENDING_ERASURE зависят от аккаунта владельца ключа — см. Состояние аккаунта владельца.

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

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

Режим доступа меняется полем mode. Поле accessMode из ответа в теле запроса не принимается: запрос с ним отвечает 200, режим ключа не меняется.

Значение, равное текущему, изменением не считается. Клиент может прислать запись ключа целиком ради переименования: тот же mode, тот же rateLimit и тот же набор scopes проходят без проверок, которые срабатывают на смену этих полей.

Права и статус меняются и в Битрикс24. Если права ключа проверяются на стороне Битрикс24, новый набор сначала передаётся на вебхук ключа и только после этого сохраняется в Вайбкод. При отказе портала ключ остаётся с прежними правами. При отзыве платформа удаляет вебхук ключа в Битрикс24 либо отключает его учётные данные.

Отзыв гасит выписанные ключом токены доступа. Вместе с переводом в REVOKED отзываются токены доступа к серверам, выписанные этим ключом.

Ключи, выданные платформой, проверяются только на возврате в работу и продлении. Сужение срока, отзыв и правка остальных полей таких ключей работают без проверок выдачи. Обычных ключей кабинета эти проверки не касаются.

Режим ключей Cowork/Code живёт на месте. Место — пара сотрудника и портала, общая для всех его устройств. Поэтому mode ключа настольного приложения здесь не меняется, а у ключа стороннего агента на подписке ограничен режимом места.

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

• Список API-ключей портала
• Создать API-ключ
• Получить API-ключ
• Удалить API-ключ
• Перевыпустить API-ключ
• Режим доступа
• Скоупы
• Менеджмент-ключи