LeadForm

A resource for creating/modifying a lead form.

Field name	Type	Conditions	Description
id	string	readabledefault_field	Form identifier
name	string	readablewritablerequiredmax_length=255	Form name
status	integer	readablewritable choices = 1 - Active 2 - Archived	Form status. Moving an active form to the archive and back is performed only via special requests. Forms in the archive cannot be updated.
created	datetime	readable	Creation time
updated	datetime	readable	Last update time
leads_count	integer	readable	Number of leads collected by the form
ad_plans_count	integer	readable	Number of ad campaigns where the form is used
ad_plan_ids	list of uint32	readable	IDs of ad campaigns where the form is used
ad_group_ids	list of uint32	readable	IDs of ad groups where the form is used
banner_ids	list of uint32	readable	IDs of ads where the form is used
active_ad_plan_ids	list of uint32	readable	IDs of active ad campaigns where the form is used
first_screen_type	string	readablewritablerequired choices = compact - compact long_text - long description award - information about the reward for completing the form	Type of the welcome section that the user sees immediately when opening the form
title	string	readablewritablerequiredmax_length=50	Form title
description	string	readablewritablemax_length=35	Form description. Displayed (and required) only when first_screen_type=compact
long_description	string	readablewritablemax_length=350	Long form description. Displayed (and required) only when first_screen_type=long_text. Maximum number of consecutive line breaks is 2.
company_title	string	readablewritablerequiredmax_length=30	Company name
logo_id	string	writeablerequired	Company logo identifier, returned when uploading the logo
logo	object	readable	Company logo
award	Award	readablewriteable	Reward for completing the form. Displayed (and required) only when first_screen_type=award
gradient	integer	readablewritable choices = 0 - #FF7583 0%, #E62E40 100% 1 - #FF80D5 0%, #E645B1 100% 2 - #FFD54F 0%, #E7A902 100% 3 - #6CD97E 0%, #12B312 100% 4 - #8AE6E6 0%, #12B3B3 100% 5 - #73D0FF 0%, #3885E1 100% 6 - #FF4D87 0%, #9F40FF 100% 100 - default color 101 - color is taken from main_color	Form background color. Values from 0 to 6 are gradients.
contact_fields	list of string	readablewritablerequired choices = first_name - First name email - Email address phone - Phone number birth_date - Date of birth city - City social_media_profile - Link to a social media profile	Contact details collected after answering the form questions
result_info	ResultInfo	readablewriteablerequired	Information for the form’s final screen
agreement	Agreement	readablewriteablerequired	Form user agreement
notifications	list of Notification	readablewriteable	Form notification settings
pages	list of Page	readablewriteablemax_items=1	List of form pages. If no pages are specified, the user will proceed directly to entering contact details when filling out the form.
required_answers	boolean	readablewritable	Flag indicating whether questions are required
main_color	string	readablewritable	Form primary color in HEX format (example: #FFFAAA)
main_image_id	string	writeable	Form cover identifier, returned when uploading the cover
main_image	object	readable	Form cover