Для AI-агентов: markdown этой страницы — /docs-content/sign-b2e/update-legal-profile.md индекс документации — /llms.txt
Изменить юридический профиль
Доступно начиная с модуля sign 26.1300.0. На старых коробочных установках метод может быть недоступен: платформа вернёт
422 METHOD_NOT_YET_AVAILABLEсerror.release.
PATCH /v1/sign-b2e/legal-profiles/:userId
Записывает юридические поля активного сотрудника или пользователя без подразделения одной транзакцией. Нужны права редактирования юридических данных; ответ содержит коды изменённых полей без значений.
Скоупы: sign.b2e, user.
Параметры пути
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
ПараметрuserId |
Типstring | Обяз.да | ОписаниеИдентификатор пользователя из списка пользователей. |
Поля запроса (body)
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
Параметрfields |
Типobject | Обяз.да | ОписаниеОбъект полей. Неизвестные поля и правила заполнения проверяет Битрикс24. |
Примеры
curl — личный ключ
curl -X PATCH 'https://vibecode.bitrix24.tech/v1/sign-b2e/legal-profiles/7' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"fields": {"UF_LEGAL_ADDRESS": "VIBE-PROBE Sample Street 10"}}'
curl — OAuth-приложение
curl -X PATCH 'https://vibecode.bitrix24.tech/v1/sign-b2e/legal-profiles/7' \
-H 'X-Api-Key: YOUR_APP_KEY' \
-H 'Authorization: Bearer USER_SESSION_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"fields": {"UF_LEGAL_ADDRESS": "VIBE-PROBE Sample Street 10"}}'
JavaScript — личный ключ
const response = await fetch('https://vibecode.bitrix24.tech/v1/sign-b2e/legal-profiles/7', {
"method": "PATCH",
"headers": {
"X-Api-Key": "YOUR_API_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({"fields": {"UF_LEGAL_ADDRESS": "VIBE-PROBE Sample Street 10"}})
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);
JavaScript — OAuth-приложение
const response = await fetch('https://vibecode.bitrix24.tech/v1/sign-b2e/legal-profiles/7', {
"method": "PATCH",
"headers": {
"X-Api-Key": "YOUR_APP_KEY",
"Authorization": "Bearer USER_SESSION_TOKEN",
"Content-Type": "application/json"
},
body: JSON.stringify({"fields": {"UF_LEGAL_ADDRESS": "VIBE-PROBE Sample Street 10"}})
});
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.userId |
Типinteger | ОписаниеИдентификатор пользователя. |
Полеdata.updated |
Типarray | ОписаниеКоды изменённых полей либо результат изменения провайдера. |
Полеmeta.redacted |
Типarray | ОписаниеПрисутствует при скрытии учётных данных; содержит пути изменённых значений. |
Пример ответа
Форма успешного ответа; данные зависят от портала и запроса.
{
"success": true,
"data": {
"userId": 7,
"updated": [
"UF_LEGAL_ADDRESS"
]
}
}
Пример ответа при ошибке
403 — ключу не выдан обязательный скоуп:
{
"success": false,
"error": {
"code": "SCOPE_DENIED",
"message": "This endpoint requires 'sign.b2e' scope"
}
}
Ошибки
| HTTP | Код | Причина |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ПричинаНеверная форма запроса: типы, обязательные поля или неизвестный параметр строки запроса. |
| HTTP401 | КодTOKEN_MISSING |
ПричинаНет учётных данных соединения с Битрикс24. |
| HTTP403 | КодSCOPE_DENIED |
ПричинаНе выдан один из обязательных скоупов. |
| HTTP422 | КодBITRIX_ERROR |
ПричинаБитрикс24 отказал в операции; код в error.b24Code, текст в error.message. |
| HTTP403 | КодWRITE_BLOCKED_READONLY_KEY |
ПричинаКлюч разрешает только чтение. |
| HTTP422 | КодMETHOD_NOT_YET_AVAILABLE |
ПричинаМетода ещё нет на портале; выпуск в error.release. |
Известные особенности
Права пользователя, доступность КЭДО, бизнес-правила, размеры страниц и содержимое полей проверяет Битрикс24. Значения передаются без локального исправления. Текст ответа кодируется в JSON; ссылки с учётными данными скрываются.
Операция автоматически не повторяется. При неизвестном результате сначала выясните состояние на портале; повторный вызов может повторно выполнить операцию.
Принимаются от 1 до 50 кодов из списка юридических полей; формат значения зависит от type и options. Адрес не может содержать символ |. Записываются все поля либо ни одного.