LeadFormField

  • The content describes a single input field within a form.

  • The input_type field defines the type of input, which can be a predefined type or a pre-vetted question.

  • The answers field defines the acceptable answer configuration, defaulting to free-text if not set.

  • single_choice_answers is used for single-choice questions with a minimum of 2 and a maximum of 12 answers.

  • has_location_answer is a boolean field for location questions, dependent on Location Assets setup for certain question types and versions.

One input field instance within a form.

Fields

input_type

LeadFormFieldUserInputType

Describes the input type, which may be a predefined type such as "full name" or a pre-vetted question like "What kind of vehicle do you have?".
Union field

answers

answers. Defines answer configuration that this form field accepts. If oneof is not set, this is a free-text answer. answers can be only one of the following:

single_choice_answers

LeadFormSingleChoiceAnswers

Answer configuration for a single choice question. Can be set only for pre-vetted question fields. Minimum of 2 answers required and maximum of 12 allowed.

has_location_answer

bool

Answer configuration for location question. If true, campaign/account level location data (state, city, business name etc) will be rendered on the Lead Form. Starting V13.1, has_location_answer can only be set for "What is your preferred dealership?" question, for advertisers with Location Assets setup at campaign/account level.