## Включить форму

`POST /v1/crm-forms/:id/activate`

Включает CRM-форму по идентификатору после проверки её конфигурации и лимита активных форм портала.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|----------|
| `id` (path) | integer | да | Идентификатор формы. Список: [`GET /v1/crm-forms`](/docs/entities/crm-forms/list) |

Параметров строки запроса у метода нет: любой такой параметр возвращает `400 INVALID_PARAMS`.

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

Тело можно не передавать или передать пустой объект `{}`. Любое поле, кроме `updatedTime`, возвращает `400 INVALID_PARAMS`.

| Поле | Тип | Обяз. | Описание |
|------|-----|:-----:|----------|
| `updatedTime` | string | нет | Время последнего изменения формы из [`GET /v1/crm-forms/:id`](/docs/entities/crm-forms/get). Если форму изменили позже этого времени, включение отклоняется с `409 CRM_FORM_VERSION_MISMATCH`. Без поля проверка версии не выполняется |

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/crm-forms/75/activate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/crm-forms/75/activate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/75/activate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
const { data } = await res.json()
console.log(data.active, data.updatedTime)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/75/activate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
const { data } = await res.json()
console.log(data.active, data.updatedTime)
```

Тип и значение `updatedTime` проверяет Битрикс24.

## Поля ответа

| Поле | Тип | Описание |
|------|-----|----------|
| `success` | boolean | `true` при успешном включении |
| `data.active` | boolean | Состояние формы после вызова |
| `data.updatedTime` | string | Время последнего изменения формы после включения, ISO 8601 со смещением часового пояса. Передаётся в следующий запрос записи |

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

```json
{
  "success": true,
  "data": {
    "active": true,
    "updatedTime": "2026-11-05T11:25:33+03:00"
  }
}
```

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

409 — форму изменили после того времени, что передано в `updatedTime`:

```json
{
  "success": false,
  "error": {
    "code": "CRM_FORM_VERSION_MISMATCH",
    "message": "Версия CRM-формы устарела, изменения не сохранены: получите форму заново и повторите запрос",
    "b24Code": "CRM_FORM_VERSION_MISMATCH",
    "currentUpdatedTime": "2026-11-05T11:25:30+03:00"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | `id` не положительное целое число, передан параметр строки запроса, тело не JSON-объект, в теле есть поле кроме `updatedTime` |
| 402 | `CRM_FORM_ACTIVATION_LIMIT_REACHED` | Достигнут лимит активных форм портала |
| 402 | `CRM_FORM_WRITE_RESTRICTED` | Тариф Битрикс24 не разрешает запись CRM-форм. На бесплатном и демо-тарифе запись не выполняется |
| 403 | `CRM_FORM_SYSTEM_IMMUTABLE` | Форма системная — `system: true` в [списке форм](/docs/entities/crm-forms/list) |
| 404 | `ENTITY_NOT_FOUND` | Формы с таким `id` нет |
| 409 | `CRM_FORM_VERSION_MISMATCH` | Форму изменили после переданного `updatedTime`. Текущее время изменения — в `error.currentUpdatedTime` |
| 403 | `BITRIX_INSUFFICIENT_SCOPE` | У токена Битрикс24 нет необходимого скоупа |
| 409 | `CRM_FORM_REST_NOT_ENABLED` | На портале выключены методы CRM-форм |
| 403 | `BITRIX_ACCESS_DENIED` | Битрикс24 отказал пользователю ключа в доступе к форме |
| 422 | `BITRIX_ERROR` | Другой отказ Битрикс24. Текст отказа — в `error.message` |
| 500 | `CRM_FORM_SIDE_EFFECT_FAILED` | Изменение уже сохранено, но завершилось с ошибкой. Перечитайте форму через [`GET /v1/crm-forms/:id`](/docs/entities/crm-forms/get) до повтора |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен или вернул ответ неожиданной формы. Перечитайте форму до повтора |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ только для чтения |
| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `crm` |
| 401 | `MISSING_API_KEY` | Не передан `X-Api-Key` |
| 401 | `TOKEN_MISSING` | У ключа нет действующей авторизации в Битрикс24 |

Ошибки портала содержат исходный код в `error.b24Code` и ошибки полей в `error.validation`, если они переданы. Коды `CRM_FORM_*` сохраняют HTTP-статус, код и сообщение. Ответы 429 и 503 описаны в разделе [Лимиты и оптимизация](/docs/optimization). Полный список общих ошибок API — [Ошибки](/docs/errors).

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

- **Лимит активных форм можно проверить заранее.** Текущее число активных форм портала — `limits.activeForms.current`, потолок — `limits.activeForms.maximum` в [конфигурации конструктора](/docs/entities/crm-forms/configuration). Когда потолок достигнут, освободите место [выключением](/docs/entities/crm-forms/deactivate) другой формы.
- **Повторный вызов не возвращает ошибку.** Включение уже активной формы отвечает `200` с `active: true`, и `updatedTime` при этом не меняется.

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

- [Выключить форму](/docs/entities/crm-forms/deactivate)
- [Получить форму](/docs/entities/crm-forms/get)
- [Список форм](/docs/entities/crm-forms/list)
- [Получить конфигурацию конструктора](/docs/entities/crm-forms/configuration)
- [Лимиты и оптимизация](/docs/optimization)