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

PATCH /v1/sites/:id

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

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор сайта
scope string нет Для сайта в разделе баз знаний передайте scope: "KNOWLEDGE" (то же значение, что при создании) — иначе сервер вернёт 403 BITRIX_ACCESS_DENIED («Доступ на изменение сайта запрещён»). Можно как поле тела или query-параметром ?scope=KNOWLEDGE. Для обычных сайтов-лендингов не требуется

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

Параметр Тип Описание
title string Название сайта, до 255 символов
code string Символьный код сайта в URL. Слеши запрещены. Если код состоит только из цифр, добавится префикс site
active boolean Принимается без ошибки, но не сохраняется — активность управляется в интерфейсе портала Битрикс24 (сайт активируется при публикации страницы)
domainId number Идентификатор домена
type string Тип сайта: PAGE, STORE или KNOWLEDGE
description string Описание сайта, до 255 символов
xmlId string Внешний идентификатор, до 255 символов
landingIdIndex number Идентификатор главной страницы сайта
landingId404 number Идентификатор страницы ошибки 404
landingId503 number Идентификатор страницы ошибки 503

Примеры

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": "/promo/",
    "type": "PAGE",
    "active": false,
    "domainId": 5,
    "createdById": 1,
    "dateCreate": "12.09.2024 10:23:14",
    "dateModify": "07.05.2026 12:18:42"
  }
}

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

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

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

Ошибки

HTTP error.code Маркер в error.message Описание
403 BITRIX_ACCESS_DENIED — Нет права на изменение сайта или указанных полей, либо сайт с таким ID не существует или недоступен — Битрикс24 отвечает «Доступ запрещён». При PATCH 404 не возвращается, в отличие от GET /v1/sites/:id
422 BITRIX_ERROR SLASH_IS_NOT_ALLOWED В code передан символ / — слеши в коде запрещены
422 BITRIX_ERROR DOMAIN_IS_INCORRECT Передан некорректный формат доменного имени
422 BITRIX_ERROR DOMAIN_EXIST Указанный домен уже занят другим сайтом
422 BITRIX_ERROR DOMAIN_EXIST_TRASH Домен привязан к сайту в корзине — сначала отвяжите его
422 BITRIX_ERROR DOMAIN_NOT_FOUND Домен с указанным domainId не существует
422 BITRIX_ERROR CODE_IS_NOT_UNIQUE Код сайта не уникален в рамках домена
403 SCOPE_DENIED — API-ключ не имеет скоупа landing
401 TOKEN_MISSING — API-ключ не имеет настроенных токенов

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

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