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

Изменить внешнего провайдера

PATCH /v1/sign-b2e/providers/:id

Изменяет внешнего провайдера подписи. Нужен OAuth администратора. Отсутствующее поле или null сохраняет прежнее значение.

Скоупы: sign.b2e.

Доступен только ключу OAuth-приложения с пользовательской сессией. Личный ключ получает 422 BITRIX_ERROR с нативным кодом WRONG_AUTH_TYPE в error.b24Code, поэтому примеры ниже даны только для OAuth-приложения.

Параметры пути

Параметр Тип Обяз. Описание
Параметрid Типstring Обяз.да ОписаниеЧисловой идентификатор внешнего провайдера из списка провайдеров.

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

Параметр Тип Обяз. Описание
Параметрfields Типobject Обяз.да ОписаниеДанные внешнего провайдера. Значения передаются Битрикс24.
Параметрfields.title Типstring | null Обяз.нет ОписаниеНазвание провайдера. null и отсутствие поля сохраняют прежнее значение.
Параметрfields.description Типstring | null Обяз.нет ОписаниеОписание провайдера. null и отсутствие поля сохраняют прежнее значение.
Параметрfields.iconUri Типstring | null Обяз.нет ОписаниеURL значка провайдера. null и отсутствие поля сохраняют прежнее значение.
Параметрfields.companyRegUri Типstring | null Обяз.нет ОписаниеURL регистрации компании. null и отсутствие поля сохраняют прежнее значение.
Параметрfields.documentSignUri Типstring | null Обяз.нет ОписаниеURL подписания документа. null и отсутствие поля сохраняют прежнее значение.
Параметрfields.publicKeyUri Типstring | null Обяз.нет ОписаниеURL открытого ключа провайдера. null и отсутствие поля сохраняют прежнее значение.

Примеры

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

Terminal
curl -X PATCH 'https://vibecode.bitrix24.tech/v1/sign-b2e/providers/7' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"fields": {"title": "VIBE-PROBE updated"}}'

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

javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/sign-b2e/providers/7', {
  "method": "PATCH",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"fields": {"title": "VIBE-PROBE updated"}})
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеУспешность запроса.
Полеdata Типobject ОписаниеДанные операции.
Полеdata.updated Типboolean ОписаниеРезультат изменения провайдера.
Полеmeta.redacted Типarray ОписаниеПрисутствует при скрытии учётных данных. Содержит пути изменённых значений.

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

Форма успешного ответа. Данные зависят от портала и запроса.

JSON
{
  "success": true,
  "data": {
    "updated": true
  }
}

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

422 — запрос с личным ключом:

JSON
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Current authorization type is denied for this method Application context required",
    "b24Code": "WRONG_AUTH_TYPE"
  }
}

Ошибки

HTTP Код Причина
HTTP400 КодINVALID_PARAMS ПричинаНеверная форма запроса: типы, обязательные поля или неизвестный параметр строки запроса.
HTTP401 КодTOKEN_MISSING ПричинаНет учётных данных соединения с Битрикс24.
HTTP403 КодSCOPE_DENIED ПричинаНе выдан один из обязательных скоупов.
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ПричинаКлюч разрешает только чтение.
HTTP422 КодBITRIX_ERROR ПричинаЗапрос с личным ключом: метод доступен только OAuth-приложению. В error.b24Code приходит WRONG_AUTH_TYPE.
HTTP422 КодBITRIX_ERROR ПричинаДругой отказ Битрикс24. Код — в error.b24Code, текст — в error.message.

Общие ошибки API.

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

Права пользователя, доступность КЭДО, бизнес-правила, размеры страниц и содержимое полей проверяет Битрикс24. Значения передаются без локального исправления. Текст ответа кодируется в JSON. Ссылки с учётными данными скрываются.

Операция автоматически не повторяется. При неизвестном результате сначала выясните состояние на портале: повторный вызов может повторно выполнить операцию.

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