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

Отправить документ по шаблону

Доступно начиная с модуля sign 26.1300.0. На старых коробочных установках метод может быть недоступен: платформа вернёт 422 METHOD_NOT_YET_AVAILABLE с error.release.

POST /v1/sign-b2e/templates/send

Создаёт и отправляет документ сотруднику по доступному шаблону. Нужны права добавления, чтения и изменения документов и доступ к шаблону. Отправка имеет юридические последствия.

Скоупы: sign.b2e, crm.

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

Параметр Тип Обяз. Описание
ПараметрtemplateUid Типstring Обяз.да ОписаниеИдентификатор шаблона из списка шаблонов.
ПараметрsignerUserId Типinteger | string Обяз.да ОписаниеИдентификатор активного сотрудника или кандидата из списка пользователей.
ПараметрresponsibleUserId Типinteger | string | null Обяз.нет ОписаниеИдентификатор активного ответственного из списка пользователей. По умолчанию владелец ключа; допустим null.
ПараметрexternalSettings Типobject | null Обяз.нет ОписаниеНастройки внешней системы; для отправки по шаблону допустим null.
ПараметрexternalSettings.externalId Типstring Обяз.нет ОписаниеИдентификатор документа во внешней системе, до 255 символов.
ПараметрexternalSettings.externalDateCreate Типstring Обяз.нет ОписаниеДата создания во внешней системе в ISO 8601. Отправка по шаблону требует ATOM с числовым смещением часового пояса.

Примеры

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

Terminal
curl -X POST 'https://vibecode.bitrix24.tech/v1/sign-b2e/templates/send' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"templateUid": "DUMMY_TEMPLATE_UID", "signerUserId": 7}'

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

Terminal
curl -X POST 'https://vibecode.bitrix24.tech/v1/sign-b2e/templates/send' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"templateUid": "DUMMY_TEMPLATE_UID", "signerUserId": 7}'

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

javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/sign-b2e/templates/send', {
  "method": "POST",
  "headers": {
    "X-Api-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"templateUid": "DUMMY_TEMPLATE_UID", "signerUserId": 7})
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);

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

javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/sign-b2e/templates/send', {
  "method": "POST",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"templateUid": "DUMMY_TEMPLATE_UID", "signerUserId": 7})
});
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.uid Типstring ОписаниеUID документа.
Полеdata.state Типobject ОписаниеСостояние объекта.
Полеdata.state.code Типstring ОписаниеМашинный код.
Полеdata.state.name Типstring ОписаниеЛокализованное название состояния подписи.
Полеdata.members Типarray ОписаниеУчастники документа.
Полеdata.members[].uid Типstring ОписаниеUID участника подписи.
Полеdata.members[].role Типstring ОписаниеРоль участника.
Полеdata.members[].state Типobject ОписаниеСостояние объекта.
Полеdata.members[].state.code Типstring ОписаниеМашинный код.
Полеdata.members[].state.name Типstring ОписаниеЛокализованное название состояния подписи.
Полеdata.members[].user Типobject ОписаниеПользователь участника.
Полеdata.members[].party Типinteger ОписаниеНомер стороны подписания участника.
Полеdata.members[].user.employeeCode Типstring | null ОписаниеКод сотрудника HCM Link; null для обычного пользователя.
Полеdata.members[].user.employeeId Типinteger | null ОписаниеЧисловой ID сотрудника HCM Link; null для обычного пользователя.
Полеdata.members[].user.userId Типinteger | null ОписаниеИдентификатор пользователя.
Полеmeta.redacted Типarray ОписаниеПрисутствует при скрытии учётных данных; содержит пути изменённых значений.

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

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

JSON
{
  "success": true,
  "data": {
    "uid": "DUMMY_DOCUMENT_UID",
    "state": {
      "code": "ready",
      "name": "Ready"
    },
    "members": []
  }
}

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

403 — ключу не выдан обязательный скоуп:

JSON
{
  "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.

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

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

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

Операция автоматически не повторяется. При неизвестном результате сначала выясните состояние на портале; повтор отправки может создать ещё один документ.

Заголовок Idempotency-Key передаётся в Битрикс24 без генерации нового значения. Он не включает автоматический повтор. externalSettings.externalDateCreate требует строгий ATOM с числовым часовым поясом.

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