Other types

Learn more about the other types used when reading, creating, updating, and deleting forms via the API

🚧 The following types are only available in API versions 2025-10 and later

The monday.com form API lets you query a form’s configuration, appearance, and behavior. With it, you can programmatically access settings such as accessibility, visual styles, features, questions, and tags.

Each of the object types described below represents a specific aspect of a form. They can be queried as subfields on the form query or provide form metadata in mutations.

CreateQuestionInput

An object containing the form question's properties.

FieldDescriptionSupported Fields
description String The question's description.
options [QuestionOptionInput!]label String!
required BooleanWhether the question must be answered to submit the form.
settings FormQuestionSettingsInputThe question's type-specific settings. checkedByDefault Boolean
defaultCurrentDate Boolean
display FormQuestionSelectDisplay
includeTime Boolean
locationAutofilled Boolean
optionsOrder FormQuestionSelectOrderByOptions
prefill PrefillSettingsInput
prefixAutofilled Boolean
prefixPredefined PhonePrefixPredefinedInput
skipValidation Boolean
title String!The question's title.
type FormQuestionType!The question's type. Determines input behavior and validation.
visible BooleanWhether the question is visible to respondents. Hidden questions remain in the form structure but aren't displayed to respondents. The default is true.

QuestionOptionInput

An array of objects defining labels for choice-based option questions.

FieldDescription
label String!The option's label to display.

DehydratedFormResponse

An object containing the result of creating a new form via the API.

FieldDescription
boardId ID!The unique identifier of the board connected to the form.
token String!The form's unique identifier.

DeleteFormTagInput

Defines the options for deleting a tag from a form via the API.

FieldDescription
deleteAssociatedColumn BooleanWhether the associated column should be deleted.

FormAccessibility

An object containing the form's accessibility options.

FieldDescription
language StringThe language code for the form's localization and interface text (e.g., "es", "en", "fr").
logoAltText StringThe form's logo image alternative text description.

FormAppearance

An object containing the form’s overall visual appearance (e.g., background, layout, colors, typography).

FieldDescriptionSupported fields
background FormBackgroundAn object containing the form's background appearance configuration. type FormBackgrounds
value String
hideBranding Boolean!Whether monday.com branding is hidden.
layout FormLayoutAn object containing the form's structure and presentation settings. alignment FormAlignment
direction FormDirection
format FormFormat
logo FormLogoAn object containing the form's logo display configurations. position FormLogoPosition
size FormLogoSize
url String
primaryColor StringThe HEX color code of the primary theme color used in the form.
showProgressBar Boolean!Whether an indicator showing the form's completion progress bar is displayed.
submitButton FormSubmitButtonAn object containing the form's submit button configurations. text String
text FormTextAn object containing the form's typography and text styling configurations. color String
font String
size FormFontSize

FormBackground

Configures the form’s background (e.g., color, image, or none).

FieldDescriptionEnum values
type FormBackgroundsThe form's background type. Color
Image
None
value StringThe form's background value.
  • For Color, it's a HEX color code.
  • For Image, it's the image's URL.
  • FormLayout

    Defines the form's layout, alignment, and format.

    FieldDescriptionEnum values
    alignment FormAlignmentThe form's text and content alignment.Center
    FullLeft
    FullRight
    Left
    Right
    direction FormDirectionThe form's reading direction.LtR
    Rtl
    format FormFormatThe form's display format. This can be a step-by-step form or a classic one-page form.Classic
    OneByOne

    FormLogo

    Configures the form’s logo (e.g., placement, size, and image URL).

    FieldDescriptionEnum values
    position FormLogoPositionThe form's logo placement.Auto
    Center
    Left
    Right
    size FormLogoSizeThe form's logo size.ExtraLarge (96px height)
    Large (72px height)
    Medium (40px height)
    Small (32px height)
    url StringThe URL for the form's logo.

    FormSubmitButton

    Defines the form's submit button text.

    FieldDescription
    text StringThe custom text displayed on the form's submit button.

    FormText

    Defines the form's typography configuration.

    FieldDescriptionEnum values
    color StringThe form's text HEX color code.
    font StringThe form's font family.
    size FormFontSizeThe form's base text size. Large
    Medium
    Small

    FormFeatures

    An object containing form-level features like login requirements, response limits, and password protection.

    FieldDescriptionSupported fields
    afterSubmissionView FormAfterSubmissionViewAn object containing the form's post-submission configuration.allowEditSubmission Boolean!
    allowResubmit Boolean!
    allowViewSubmission Boolean!
    description String
    redirectAfterSubmission FormRedirectAfterSubmission
    showSuccessImage Boolean!
    title String
    closeDate FormCloseDateAn object containing the form's automatic closure configuration. date String
    enabled Boolean!
    draftSubmission FormDraftSubmissionAn object containing the form's draft saving configuration. enabled Boolean!
    isInternal Boolean!Whether the form is restricted to internal users only.
    monday FormMondayAn object containing the board's settings for response handling. includeNameQuestion Boolean!
    includeUpdateQuestion Boolean!
    itemGroupId String
    syncQuestionAndColumnsTitles Boolean!
    password FormPasswordAn object containing the form's password protection configuration.enabled Boolean!
    preSubmissionView FormPreSubmissionViewAn object containing the form's welcome screen configuration. description String
    enabled Boolean!
    startButton FormStartButton
    title String
    reCaptchaChallenge Boolean!Whether the form has reCAPTCHA verification enabled to prevent spam submissions.
    requireLogin FormRequireLoginAn object containing the form's login requirement settings. enabled Boolean!
    redirectToLogin Boolean!
    responseLimit FormResponseLimitAn object containing the form's response limitation settings.enabled Boolean!
    limit Int
    shortenedLink FormShortenedLinkAn object containing the form's shortened URL configuration.enabled Boolean!
    url String

    FormAfterSubmissionView

    An object containing the form's post-submission settings.

    FieldDescriptionSupported fields
    allowEditSubmission Boolean!Whether users can edit their responses after submission.
    allowResubmit Boolean!Whether users can submit multiple responses to the same form.
    allowViewSubmission Boolean!Whether users can view their answers after submission.
    description StringThe text displayed after form submission.
    redirectAfterSubmission FormRedirectAfterSubmissionAn object containing the redirect configuration after form submission.enabled Boolean!
    redirectUrl String
    showSuccessImage Boolean!Whether a success image appears after form submission.
    title StringThe title text displayed after form submission.

    FormRedirectAfterSubmission

    An object containing the form's post-submission redirect configuration.

    FieldDescription
    enabled Boolean!Whether responders are automatically redirected to a specified URL after form completion.
    redirectUrl StringThe URL where users are redirected after successfully completing the form.

    FormCloseDate

    An object containing the form's automatic closure configuration.

    FieldDescription
    date StringThe ISO 8601 timestamp when the form will automatically stop accepting responses.
    enabled Boolean!Whether the form automatically closes at a specified date and time.

    FormDraftSubmission

    An object containing the form's draft saving configuration.

    FieldDescription
    enabled Boolean!Whether users are allowed to save incomplete responses as drafts.

    FormMonday

    An object containing the form's board settings for response handling.

    FieldDescription
    includeNameQuestion Boolean!Whether a name question is added to the form. Corresponds to the item name column on the board.
    includeUpdateQuestion Boolean!Whether an update field is added to the form. Corresponds to the updates section of the associated item.
    itemGroupId StringThe board group ID where new items will be created from form responses.
    syncQuestionAndColumnsTitles Boolean!Whether the form question title syncs with the board column name.

    FormPassword

    An object containing the form's password protection configuration.

    FieldDescription
    enabled Boolean!Whether users must enter a password to access the form.

    FormPreSubmissionView

    An object containing the settings for the optional welcome screen shown before the form begins.

    FieldDescriptionSupported fields
    description StringThe text displayed on the welcome screen (e.g., extra context, instructions).
    enabled Boolean!Whether a welcome screen is displayed before starting the form.
    startButton FormStartButtonAn object containing the form's welcome screen start button configuration.text String
    title StringThe title text displayed on the welcome screen.

    FormRequireLogin

    An object containing the form's login requirement settings.

    FieldDescription
    enabled Boolean!Whether the form requires users to log in before submitting responses.
    redirectToLogin Boolean!Whether unauthenticated users are automatically redirected to the login page.

    FormResponseLimit

    An object containing the form's response limitation settings.

    FieldDescription
    enabled Boolean!Whether the form's response limits are enabled.
    limit IntThe maximum number of form responses allowed.

    FormShortenedLink

    An object containing the form's shortened URL configuration.

    FieldDescription
    enabled Boolean!Whether shortened URLs can be generated.
    url StringThe form's generated, shortened URL. Only available when shortened links are enabled.

    FormQuestion

    An array of objects containing the form's question content, in display order.

    FieldDescriptionSupported fields
    description StringOptional text providing additional context, instructions, or examples for the question.
    id String!The question's unique identifier.
    options [FormQuestionOption!]The available options for choice-based questions. Each option defines a display label.label String!
    required Boolean!Whether the question must be answered to submit the form.
    settings FormQuestionSettingsAn object containing question type-specific configurations. checkedByDefault Boolean
    defaultCurrentDate Boolean
    display FormQuestionSelectDisplay
    includeTime Boolean
    limit Int
    locationAutofilled Boolean
    optionsOrder FormQuestionSelectOrderByOptions
    prefill PrefillSettings
    prefixAutofilled Boolean
    prefixPredefined PhonePrefixPredefined
    skipValidation Boolean
    showIfRules JSONConditional logic rules that determine whether the question is displayed, based on responses to other questions.
    title String!The question's title. Must be at least one character long.
    type FormQuestionTypeThe question's type. Determines input behavior and validation.
    visible Boolean!Whether the question is visible to responders. Hidden questions remain in the form structure but aren't displayed to responders.

    FormQuestionOption

    An array containing the available options for choice-based questions.

    FieldDescription
    label String!The display text for individual option choices (in select-type questions).

    FormQuestionSettings

    An object containing the form's question type-specific configuration. If a type-specific setting is provided (e.g., includeTime), the form must contain a question of that type, or the mutation won't work.

    FieldDescriptionEnum valuesSupported fields
    checkedByDefault BooleanWhether the box should be checked by default. Only for boolean and checkbox questions.
    defaultCurrentDate BooleanWhether the current date is set as the default value. Only for date questions.
    display FormQuestionSelectDisplayThe display options for select-type questions. Only for single or multiple select questions.Dropdown
    Horizontal
    Vertical
    includeTime BooleanWhether the time selection (hours and minutes) is included with the date selector. If false, only the date is included. Only for date questions.
    limit IntThe maximum rating value that can be selected. Only for rating questions.
    locationAutofilled BooleanWhether the responder's location is automatically detected and filled. Uses the browser's geolocation services. Requires user permission. Only for location questions.
    optionsOrder FormQuestionSelectOrderByOptionsThe ordering options for select questions. Only for single or multiple select questions.Alphabetical
    Custom
    Random
    prefill PrefillSettingsThe configuration for automatically populating question values.enabled Boolean!
    lookup String!
    source FormQuestionPrefillSources
    prefixAutofilled BooleanWhether the phone country prefix is automatically detected and filled. Uses the responder's geographic location or browser settings. Only for phone questions.
    prefixPredefined PhonePrefixPredefinedThe configuration for setting a predefined phone country prefix that will be pre-selected for responders. Only for phone questions.enabled Boolean!
    prefix String
    skipValidation BooleanWhether URL format validation is skipped, allowing any text input. Only for link/URL questions.

    PhonePrefixPredefined

    Defines the configuration for pre-selecting a phone country prefix for responders.

    FieldDescription
    enabled Boolean!Whether a pre-defined phone country prefix is enabled for phone number questions. If true, the specified prefix will be pre-selected.
    prefix StringThe predefined phone country prefix in capital letters (e.g., "US", "UK").

    PrefillSettings

    Defines the configuration for auto-populating question values.

    FieldDescriptionEnum values
    enabled Boolean!Whether the question's prefill functionality is enabled. If true, the values will be auto-populated from the specified source.
    lookup String!The field or parameter name to lookup from the prefill source. For Account sources, this is a user property like name or email. For QueryParam sources, this is the parameter name that's set in the URL.
    source FormQuestionPrefillSourcesThe sources for prefilling question values.Account
    QueryParam

    FormQuestionType

    Supported enum values for FormQuestionType.

    BooleanConnectedBoardsCountryDateDateRangeEmailFile
    LinkLocationLongTextMultiSelectNameNumberPeople
    PhoneRatingShortTextSignatureSingleSelectSubitemsUpdates

    FormTag

    An array of tracking tags for categorization and analytics.

    query {
      form(formToken: "YOUR_FORM_TOKEN") {
        tags {
          id
          name
          value
          columnId
        }
      }
    }
    
    {
      "data": {
        "form": {
          "tags": [
            {
              "id": "8f2a91c4-6d9a-49c3-bf12-93b4f019d7e1",
              "columnId": "short_textxjwe48lm",
              "value": "ENGLISH",
              "name": "LANGUAGE"
            }
          ]
        }
      },
      "extensions": {
        "request_id": "2d74c9f0-5b21-4e68-a123-8f91bb47e0cd"
      }
    }
    
    FieldDescription
    columnId String!The unique identifier of the column the tag is associated with.
    id String!The tag's unique identifier.
    name String!The tag's name.
    value StringThe tag's value.

    ResponseForm

    An object containing the form's accessibility, appearance, features, questions, and tags.

    FieldDescriptionSupported subfields
    accessibility FormAccessibilityThe form's accessibility settings. language String
    logoAltText String
    active Boolean!Whether the form is visible and accepting responses.
    appearance FormAppearanceThe form's visual style settings. background FormBackground
    hideBranding Boolean!
    layout FormLayout
    logo FormLogo
    primaryColor String
    showProgressBar Boolean!
    submitButton FormSubmitButton
    text FormText
    createWithAi Boolean!Whether the form was originally created with monday.com’s AI-assisted form builder.
    description StringThe optional form description, displayed below the title.
    features FormFeaturesThe form's toggles and feature settings.afterSubmissionView FormAfterSubmissionView
    closeDate FormCloseDate
    draftSubmission FormDraftSubmission
    isInternal Boolean!
    monday FormMonday
    password FormPassword
    preSubmissionView FormPreSubmissionView
    reCaptchaChallenge Boolean!
    requireLogin FormRequireLogin
    responseLimit FormResponseLimit
    shortenedLink FormShortenedLink
    id Int!The form's unique board view identifier.
    isAnonymous Boolean!Whether responses are collected anonymously.
    isSuspicious Boolean!Whether the form has been flagged for suspicious content or activity.
    ownerId IntThe user ID of the form's owner/creator.
    questions [FormQuestion!]An array of question objects that make up the form, in display order.description String
    id String!
    options [FormQuestionOption!]
    required Boolean!
    settings FormQuestionSettings
    showIfRules JSON
    title String!
    type FormQuestionType
    visible Boolean!
    tags [FormTag!]Tracking tags for categorization and analytics. columnId String!
    id String!
    name String!
    value String
    title String!Title displayed at the top of the form.
    token String!The form's string-based unique token. Used in API queries and mutations.
    type StringThe form's type.

    UpdateFormInput

    An object defining the form's properties to update.

    FieldDescriptionSupported Fields
    description StringThe form's updated description.
    questions [QuestionOrderInput!]An ordered array of all question IDs in the form. Must include every existing question ID, and their order determines the display order of the questions.id String!
    title StringThe form's updated title. Must be at least one character long.

    UpdateFormSettingsInput

    An object defining the form settings inputs to update.

    FieldDescriptionSupported Fields
    accessibility FormAccessibilityInputThe form's updated accessibility settings.language String
    logoAltText String
    appearance FormAppearanceInputThe form's updated visual style settings.background FormBackgroundInput
    hideBranding Boolean
    layout FormLayoutInput
    logo FormLogoInput
    primaryColor String
    showProgressBar Boolean
    submitButton FormSubmitButtonInput
    text FormTextInput
    features FormFeaturesInputThe form's updated toggles and feature settings.afterSubmissionView FormAfterSubmissionViewInput
    closeDate FormCloseDateInput
    draftSubmission FormDraftSubmissionInput
    monday FormMondayInput
    password FormPasswordInput
    preSubmissionView FormPreSubmissionViewInput
    reCaptchaChallenge Boolean
    requireLogin FormRequireLoginInput
    responseLimit FormResponseLimitInput

    FormAccessibilityInput

    An object containing the updated input for the form's updated accessibility options.

    FieldDescription
    language StringThe language code for the form's localization and interface text (e.g., "es", "en", "fr").
    logoAltText StringThe form's logo image alternative text description.

    FormAppearanceInput

    An object containing the updated input for the form’s overall visual appearance (e.g., background, layout, colors, typography).

    FieldDescriptionSupported fields
    background FormBackgroundInputAn object containing the form's updated background appearance configuration input. type FormBackgrounds!
    value String
    hideBranding BooleanWhether monday.com branding is hidden.
    layout FormLayoutInputAn object containing the form's updated structure and presentation settings input. alignment FormAlignment
    direction FormDirection
    format FormFormat
    logo FormLogoInputAn object containing the form's updated logo display configuration input. position FormLogoPosition
    size FormLogoSize
    url String
    primaryColor StringThe HEX color code of the primary theme color used in the form.
    showProgressBar BooleanWhether an indicator showing the form's updated completion progress bar is displayed.
    submitButton FormSubmitButtonInputAn object containing the form's updated submit button configuration input. text String
    text FormTextInputAn object containing the form's updated typography and text styling configuration input. color String
    font String
    size FormFontSize

    FormBackgroundInput

    Configures the form’s updated background input (e.g., color, image, or none).

    FieldDescriptionEnum values
    type FormBackgrounds!The form's background type. Color
    Image
    None
    value StringThe form's background value.
  • For Color, it's a HEX color code.
  • For Image, it's the image's URL.
  • FormLayoutInput

    Defines the form's updated layout, alignment, and format input.

    FieldDescriptionEnum values
    alignment FormAlignmentThe form's text and content alignment.Center
    FullLeft
    FullRight
    Left
    Right
    direction FormDirectionThe form's reading direction.LtR
    Rtl
    format FormFormatThe form's display format. This can be a step-by-step form or a classic one-page form.Classic
    OneByOne

    FormLogoInput

    Configures the form’s updated logo input (e.g., placement, size, and image URL).

    FieldDescriptionEnum values
    position FormLogoPositionThe form's logo placement.Auto
    Center
    Left
    Right
    size FormLogoSizeThe form's logo size.ExtraLarge (96px height)
    Large (72px height)
    Medium (40px height)
    Small (32px height)

    FormSubmitButtonInput

    Defines the form's updated submit button text.

    FieldDescription
    text StringThe custom text displayed on the form's submit button.

    FormTextInput

    Defines the form's updated typography configuration.

    FieldDescriptionEnum values
    color StringThe form's text HEX color code.
    font StringThe form's font family.
    size FormFontSizeThe form's base text size. Large
    Medium
    Small

    FormFeaturesInput

    An object containing the input for form-level features like login requirements, response limits, and password protection.

    FieldDescriptionSupported fields
    afterSubmissionView FormAfterSubmissionViewInputAn object containing the form's updated post-submission configuration input.allowEditSubmission Boolean
    allowResubmit Boolean
    allowViewSubmission Boolean
    description String
    redirectAfterSubmission FormRedirectAfterSubmissionInput
    showSuccessImage Boolean
    title String
    closeDate FormCloseDateInputAn object containing the form's updated automatic closure configuration input. date String
    enabled Boolean
    draftSubmission FormDraftSubmissionInputAn object containing the form's updated draft saving configuration input. enabled Boolean
    monday FormMondayInputAn object containing the updated board's settings input for response handling. includeNameQuestion Boolean
    includeUpdateQuestion Boolean
    itemGroupId String
    syncQuestionAndColumnsTitles Boolean
    password FormPasswordInputAn object containing the form's updated password protection configuration input.enabled Boolean
    preSubmissionView FormPreSubmissionViewInputAn object containing the form's updated welcome screen configuration input. description String
    enabled Boolean
    startButton FormStartButtonInput
    title String
    reCaptchaChallenge BooleanWhether the form has reCAPTCHA verification enabled to prevent spam submissions.
    requireLogin FormRequireLoginInputAn object containing the form's updated login requirement settings input. enabled Boolean
    redirectToLogin Boolean
    responseLimit FormResponseLimitInputAn object containing the form's updated response limitation settings input.enabled Boolean
    limit Int

    FormAfterSubmissionViewInput

    An object containing the form's updated post-submission settings.

    FieldDescriptionSupported fields
    allowEditSubmission BooleanWhether users can edit their responses after submission.
    allowResubmit BooleanWhether users can submit multiple responses to the same form.
    allowViewSubmission BooleanWhether users can view their answers after submission.
    description StringThe text displayed after form submission.
    redirectAfterSubmission FormRedirectAfterSubmissionInputAn object containing the redirect configuration after form submission.enabled Boolean
    redirectUrl String
    showSuccessImage BooleanWhether a success image appears after form submission.
    title StringThe title text displayed after form submission.

    FormRedirectAfterSubmissionInput

    An object containing the form's updated post-submission redirect configuration input.

    FieldDescription
    enabled BooleanWhether responders are automatically redirected to a specified URL after form completion.
    redirectUrl StringThe URL where users are redirected after successfully completing the form.

    FormCloseDateInput

    An object containing the form's updated automatic closure configuration.

    FieldDescription
    date StringThe ISO 8601 timestamp when the form will automatically stop accepting responses.
    enabled BooleanWhether the form automatically closes at a specified date and time.

    FormDraftSubmissionInput

    An object containing the form's updated draft saving configuration input.

    FieldDescription
    enabled BooleanWhether users are allowed to save incomplete responses as drafts.

    FormMondayInput

    An object containing the form's updated board settings input for response handling.

    FieldDescription
    includeNameQuestion BooleanWhether a name question is added to the form. Corresponds to the item name column on the board.
    includeUpdateQuestion BooleanWhether an update field is added to the form. Corresponds to the updates section of the associated item.
    itemGroupId StringThe board group ID where new items will be created from form responses.
    syncQuestionAndColumnsTitles BooleanWhether the form question title syncs with the board column name.

    FormPasswordInput

    An object containing the form's updated password protection configuration input.

    FieldDescription
    enabled BooleanWhether users must enter a password to access the form. This can only be used to disable password protection. To enable it, use the set_form_password mutation.

    FormPreSubmissionViewInput

    An object containing the updated settings input for the optional welcome screen shown before the form begins.

    FieldDescriptionSupported fields
    description StringThe text displayed on the welcome screen.
    enabled BooleanWhether a welcome screen is displayed before starting the form.
    startButton FormStartButtonInputAn object containing the form's welcome screen start button configuration input.text String
    title StringThe title text displayed on the welcome screen.

    FormRequireLoginInput

    An object containing the form's updated login requirement settings input.

    FieldDescription
    enabled BooleanWhether the form requires users to log in before submitting responses.
    redirectToLogin BooleanWhether unauthenticated users are automatically redirected to the login page.

    FormResponseLimitInput

    An object containing the form's updated response limitation settings input.

    FieldDescription
    enabled BooleanWhether the form's response limits are enabled.
    limit IntThe maximum number of form responses allowed.

    UpdateQuestionInput

    An object containing the question's updated properties.

    FieldDescriptionSupported Fields
    description String The question's updated description.
    required BooleanWhether the question must be answered to submit the form.
    settings FormQuestionSettingsInputThe question's updated type-specific settings. checkedByDefault Boolean
    defaultCurrentDate Boolean
    display FormQuestionSelectDisplay
    includeTime Boolean
    locationAutofilled Boolean
    optionsOrder FormQuestionSelectOrderByOptions
    prefill PrefillSettingsInput
    prefixAutofilled Boolean
    prefixPredefined PhonePrefixPredefinedInput
    skipValidation Boolean
    title StringThe question's updated title.
    type FormQuestionType!The question's updated type that determines input behavior and validation. You can't pass a new question type—it must match the type of the existing question.
    visible BooleanWhether the question is visible to respondents. Hidden questions remain in the form structure but aren't displayed to respondents.

    FormQuestionSettingsInput

    An object containing the question's updated type-specific configuration. If a type-specific setting is provided (e.g., includeTime), the form must contain a question of that type, or the mutation won't work.

    FieldDescriptionEnum valuesSupported fields
    checkedByDefault BooleanWhether the box should be checked by default. Only for boolean and checkbox questions.
    defaultCurrentDate BooleanWhether the current date is set as the default value. Only for date questions.
    display FormQuestionSelectDisplayThe display options for select-type questions. Only for single or multiple select questions.Dropdown
    Horizontal
    Vertical
    includeTime BooleanWhether the time selection (hours and minutes) is included with the date selector. If false, only the date is included. Only for date questions.
    locationAutofilled BooleanWhether the responder's location is automatically detected and filled. Uses the browser's geolocation services. Requires user permission. Only for location questions.
    optionsOrder FormQuestionSelectOrderByOptionsThe ordering options for select questions. Only for single or multiple select questions.Alphabetical
    Custom
    Random
    prefill PrefillSettingsInputThe configuration for automatically populating question values.enabled Boolean!
    lookup String
    source FormQuestionPrefillSources
    prefixAutofilled BooleanWhether the phone country prefix is automatically detected and filled. Uses the responder's geographic location or browser settings. Only for phone questions.
    prefixPredefined PhonePrefixPredefinedInputThe configuration for setting a predefined phone country prefix that will be pre-selected for responders. Only for phone questions.enabled Boolean!
    prefix String
    skipValidation BooleanWhether URL format validation is skipped, allowing any text input. Only for link/URL questions.

    PhonePrefixPredefinedInput

    Defines the configuration for pre-selecting a phone country prefix for responders.

    FieldDescription
    enabled Boolean!Whether a pre-defined phone country prefix is enabled for phone number questions. If true, the specified prefix will be pre-selected.
    prefix StringThe predefined phone country prefix in capital letters (e.g., "US", "UK").

    PrefillSettingsInput

    Defines the configuration for auto-populating question values.

    FieldDescriptionEnum values
    enabled Boolean!Whether the question's prefill functionality is enabled. If true, the values will be auto-populated from the specified source.
    lookup StringThe field or parameter name to look up from the prefill source. For Account sources, this is a user property like name or email. For QueryParam sources, this is the parameter name that's set in the URL.
    source FormQuestionPrefillSourcesThe sources for prefilling question values.Account
    QueryParam