leadForms.create

Создаёт форму сбора заявок.

Этот метод можно вызвать с ключом доступа пользователя.

Требуются права доступа: groups.

Параметры

group_id

string

Идентификатор группы, в которой надо создать форму.

name

string

Название формы (видно только администратору).

title

string

Заголовок формы (видят пользователи).

description

string

Описание формы.

questions

string

Информация о вопросах формы. Массив структур следующего формата:

•
type — тип вопроса;
•
label — заголовок вопроса (только для нестандартных вопросов);
•
key — уникальный ключ вопроса (необязательно; только для нестандартных вопросов);
•
options — массив возможных ответов на вопрос (только для нестандартных вопросов типа radio, select, checkbox).

Типы стандартных вопросов:

•
first_name — имя;
•
patronymic_name — отчество;
•
last_name — фамилия;
•
email — адрес электронной почты;
•
phone_number — номер телефона;
•
age — возраст;
•
birthday — день рождения;
•
location — город и страна.

Типы нестандартных вопросов:

•
input — простое текстовое поле (строка);
•
textarea — большое текстовое поле (абзац);
•
radio — выбор одного из нескольких вариантов;
•
checkbox — выбор нескольких вариантов;
•
select — выбор одного варианта из выпадающего списка.

options должен быть массивом структур, описывающих варианты ответа:

•
label — текст ответа;
•
key — ключ ответа (необязательно).

Пример:

JSON

[[
   {
      "type":"first_name"
   },
   {
      "type":"input",
      "label":"Кличка кота"
   },
   {
      "type":"select",
      "key":"favorite_color",
      "label":"Любимый цвет",
      "options":[{
        "key":"red",
        "label":"Красный"
      },{
        "key":"green",
        "label":"Зелёный"
      }]]
   },
   {
      "type":"radio",
      "label":"Я ношу часы...",
      "options":[[{
         "key":"left",
         "label":"на левой руке"
      },{
         "key":"right",
         "label":"на правой руке"
      }]]
   },
   {
      "type":"checkbox",
      "key":"visited_cities",
      "label":"Города, в которых я был",
      "options":[[{
         "label":"Екатеринбург"
      },{
         "label":"Волгоград"
      },{
         "label":"Санкт-Петербург"      
      }]]
   }
]

policy_link_url

string

Ссылка на политику конфиденциальности.

photo

string

Обложка формы.

Используйте значение, полученное после загрузки фотографии на сервер. См. метод leadForms.getUploadURL.

Также можно переиспользовать существующую фотографию из другой формы. Используйте значение поля photo, которое возвращает метод leadForms.get или leadForms.list.

confirmation

string

Текст подтверждения, который увидит пользователь после отправки формы.

site_link_url

string

Ссылка на сайт или сообщество автора формы.

active

string

Передайте 1, чтобы активировать форму сразу после создания. Пользователи могут оставлять заявки только в активных формах.

once_per_user

string

Передайте 1, чтобы разрешить каждому пользователю заполнять форму только один раз.

pixel_code

string

Передайте код пикселя ретаргетинга ВКонтакте в виде VK-RTRG-000000-XXXXX. По этому пикселю будет собираться аудитория пользователей, открывших форму. Подробнее о пикселе см. здесь.

notify_admins

string

Передайте список идентификаторов пользователей, которым будут отправлены оповещения о заполнении пользователями формы. Оповещения могут быть отправлены только администраторам сообщества.

notify_emails

string

Передайте список email-адресов, разделённых запятой, на которые будут отправлены оповещения о заполнении пользователями формы. Можно указать до 10 адресов.

Результат

Возвращается структура с информацией о созданной форме:

•
form_id — идентификатор формы;
•
url — ссылка на форму.

Коды ошибок

В ходе выполнения могут произойти общие ошибки.