#Обновить сайт

PATCH /v1/sites/:id

Обновляет поля существующего сайта. Передавайте только изменяемые поля плоско в корне JSON — без обёртки fields.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор сайта

#Поля для обновления (body)

Параметр Тип Описание
title string Название сайта, до 255 символов
code string Символьный код сайта в URL. Слеши запрещены. Чисто-цифровому коду добавится префикс site
active boolean Активен ли сайт
domainId number Идентификатор домена
type string Тип сайта: PAGE или STORE

#Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/sites/157" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Вилла Ранду — обновлено",
    "active": false
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/sites/157" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Вилла Ранду — обновлено",
    "active": false
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/sites/157', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Вилла Ранду — обновлено',
    active: false,
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/sites/157', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Вилла Ранду — обновлено',
    active: false,
  }),
})

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

#Поля ответа

Поле Тип Описание
data object Обновлённый объект сайта со всеми ключевыми полями

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

JSON 
{
  "success": true,
  "data": {
    "id": 157,
    "title": "Вилла Ранду — обновлено",
    "code": "/villa-randu/",
    "type": "PAGE",
    "active": false,
    "domainId": 5,
    "createdById": 1,
    "dateCreate": "2024-09-12T10:23:14.000Z",
    "dateModify": "2026-05-07T12:18:42.000Z"
  }
}

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

403 — нет прав на обновление этого сайта:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "Access denied"
  }
}

#Ошибки

HTTP error.code Маркер в error.message Описание
404 ENTITY_NOT_FOUND — Сайт с таким ID не найден
403 BITRIX_ACCESS_DENIED — У пользователя нет права на изменение этого сайта или указанных полей
400 BITRIX_ERROR SLASH_IS_NOT_ALLOWED В code передан символ / — слеши в коде запрещены
400 BITRIX_ERROR DOMAIN_IS_INCORRECT Передан некорректный формат доменного имени
400 BITRIX_ERROR DOMAIN_EXIST Указанный домен уже занят другим сайтом
400 BITRIX_ERROR DOMAIN_EXIST_TRASH Домен привязан к сайту в корзине — сначала отвяжите его
400 BITRIX_ERROR DOMAIN_NOT_FOUND Домен с указанным domainId не существует
400 BITRIX_ERROR CODE_IS_NOT_UNIQUE Код сайта не уникален в рамках домена
403 SCOPE_DENIED — API-ключ не имеет скоупа landing
401 TOKEN_MISSING — API-ключ не имеет настроенных токенов

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

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