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

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

`POST /v1/sign-b2e/templates/send`

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

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

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

| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| `templateUid` | string | да | Идентификатор шаблона из [списка шаблонов](./list-templates.md). |
| `signerUserId` | integer \| string | да | Идентификатор активного сотрудника или кандидата из [списка пользователей](/docs/entities/users). |
| `responsibleUserId` | integer \| string \| null | нет | Идентификатор активного ответственного из [списка пользователей](/docs/entities/users). По умолчанию владелец ключа; допустим null. |
| `externalSettings` | object \| null | нет | Настройки внешней системы; для отправки по шаблону допустим null. |
| `externalSettings.externalId` | string | нет | Идентификатор документа во внешней системе, до 255 символов. |
| `externalSettings.externalDateCreate` | string | нет | Дата создания во внешней системе в ISO 8601. Отправка по шаблону требует ATOM с числовым смещением часового пояса. |

## Примеры

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

```bash
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-приложение

```bash
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<string> | Присутствует при скрытии учётных данных; содержит пути изменённых значений. |

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

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

```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 | Код | Причина |
|---|---|---|
| 400 | `INVALID_PARAMS` | Неверная форма запроса: типы, обязательные поля или неизвестный параметр строки запроса. |
| 401 | `TOKEN_MISSING` | Нет учётных данных соединения с Битрикс24. |
| 403 | `SCOPE_DENIED` | Не выдан один из обязательных скоупов. |
| 422 | `BITRIX_ERROR` | Битрикс24 отказал в операции; код в error.b24Code, текст в error.message. |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ разрешает только чтение. |
| 422 | `METHOD_NOT_YET_AVAILABLE` | Метода ещё нет на портале; выпуск в error.release. |

[Общие ошибки API](/docs/errors).

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

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

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

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

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

- [Подпись сотрудников](/docs/sign-b2e)
- [Ошибки API](/docs/errors)
