Перейти к основному содержанию
POST
cURL
Используйте этот endpoint, чтобы создавать простые анкеты через API. Передайте массив form_elements в том порядке, в котором пользователи будут отвечать на вопросы. Граф анкеты для вас строит Didit. API поддерживает только простые линейные анкеты. Не передавайте graph, branches, next и условные правила.

Обязательные поля

  • title: внутреннее название анкеты.
  • languages должен включать en.
  • form_elements должен содержать хотя бы один вопрос.
  • Каждый элемент формы требует element_type и переведённый label.
Вы также можете добавить к элементу формы необязательный переведённый description как текст подсказки. Он принимается для всех типов элементов, кроме separator, и возвращается как description элемента в отчёте по анкете.

Типы элементов

Используйте значения в нижнем регистре, например short_text, multiple_choice, email, file_upload или date_picker. Значения перечислений в верхнем регистре, например SHORT_TEXT, также принимаются. Для dropdown, single_choice и multiple_choice добавьте options. Если вы не укажете value для варианта, Didit создаст его из подписи.

Проверка полей

Добавьте необязательный объект validation к элементу short_text, long_text или number, чтобы задать формат ответа пользователя. Это полезно для идентификаторов со строгим форматом, например налоговых номеров, национальных идентификаторов или номеров карт. Проверка выполняется, пока пользователь заполняет поле (дальше он не может перейти, пока значение не пройдёт проверку), и API повторно применяет её при отправке.
Ответ содержит questionnaire_id. Сохраните его: он понадобится как questionnaire_uuid, когда вы будете добавлять анкету в сценарий.

Авторизации

x-api-key
string
header
обязательно

API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.

Тело

application/json

Создайте простую линейную анкету. API преобразует form_elements во внутренний граф анкеты.

title
string
обязательно

Внутреннее название анкеты.

languages
string[]
обязательно

Языки, включённые в каждую метку. Должен включать en.

Пример:
form_elements
object[]
обязательно

Вопросы в точном порядке, в котором их должны видеть пользователи. Ветвление и условные поля не поддерживаются.

Minimum array length: 1
description
string | null
default_language
string

Язык по умолчанию. Должен быть включён в languages.

Пример:

"en"

is_active
boolean
по умолчанию:true
status
enum<string>

Опустите это поле, чтобы создать опубликованную анкету, готовую к использованию в сценариях.

Доступные опции:
draft,
published

Ответ

Анкета создана. Ответ содержит questionnaire_id — сохраните его, чтобы ссылаться на эту анкету из сценариев или в будущих вызовах обновления/удаления.

Полные сведения об анкете, возвращаемые из endpoint’ов GET, POST (создание) и PATCH (обновление).

questionnaire_id
string<uuid>

Уникальный идентификатор анкеты. Используйте этот id при ссылке на анкету из сценария или в последующих запросах на обновление/удаление.

title
string
description
string | null
languages
string[]
default_language
string
is_active
boolean
is_simple_questionnaire
boolean
graph
object

Структура графа с полем start_node и отображением nodes.

sections
object[]

Содержимое анкеты, сгруппированное по разделам (на основе графа).

questionnaire_group_id
string<uuid>

Постоянный идентификатор, объединяющий все версии одной и той же анкеты.

version
integer
status
enum<string>
Доступные опции:
draft,
published
published_at
string<date-time> | null
is_editable
boolean

True, когда анкету всё ещё можно редактировать на месте (черновые версии).

Последнее изменение 7 ноября 2026 г.