Create a form

Creates a new form with a schema defining its fields. The schema is a JSON array of field definitions with types, labels, validation rules, and conditional logic.

Required permissions
forms.create
POST/forms
Base URLhttps://api.lynkow.com/v1

Request body
required

  • name
    string
    required

    Required. Display name. 1-255 characters

  • slug
    string
    required

    Required. URL-friendly identifier, unique per site and locale. 1-255 characters

  • locale
    string

    BCP 47 locale code (e.g. "en", "fr")

  • schema
    object
    required

    Required. Field schema definition

    • pages
      array<object>
      • title
        string
      • fields
        array<string>
        required
      • description
        string
    • fields
      array<object>
      required
      • id
        string
        required
      • type
        enum
        required

        One of: textemailteltextareaselectcheckboxradiodatedatetimetimenumberfileratinghidden

      • label
        string
        required
      • width
        enum

        One of: fullhalfthird

      • options
        array<object>
        • label
          string
          required
        • value
          string
          required
      • required
        boolean
      • conditions
        array<object>
        • field
          string
          required
        • value
          any
        • action
          enum
          required

          One of: showhiderequireskip_to_page

        • operator
          enum
          required

          One of: equalsnot_equalscontainsnot_containsgreater_thanless_thanis_emptyis_not_empty

        • targetPage
          number
      • validation
        object
        • max
          number
        • min
          number
        • accept
          string
        • maxSize
          number
        • pattern
          string
        • maxLength
          number
        • minLength
          number
      • description
        string
      • placeholder
        string
      • defaultValue
        any
    • settings
      object
      • redirectUrl
        string
      • requireAuth
        boolean
      • submitLabel
        string
      • closedMessage
        string
      • successMessage
        string
      • showProgressBar
        boolean
    • conditions
      array<object>
      • field
        string
        required
      • value
        any
      • action
        enum
        required

        One of: showhiderequireskip_to_page

      • operator
        enum
        required

        One of: equalsnot_equalscontainsnot_containsgreater_thanless_thanis_emptyis_not_empty

      • targetPage
        number
  • status
    enum

    One of: draft, active, closed, archived

    One of: draftactiveclosedarchived

  • settings
    object

    Configuration settings

    • description
      string

      Description text. Max 1000 characters

    • notifications
      object

      Notification preferences

      • email
        object
        • to
          array<string>
          required
        • enabled
          boolean
          required
        • replyTo
          string
        • subject
          string
        • template
          string
      • webhook
        object
        • url
          string
          required
        • method
          enum

          One of: POSTPUT

        • enabled
          boolean
          required
        • headers
          object
          • retryCount
            number
      • honeypotEnabled
        boolean

        Boolean

      • recaptchaEnabled
        boolean

        Boolean

      • recaptchaSiteKey
        string

        Max 255 characters

      • recaptchaSecretKey
        string

        Max 255 characters

      Feedback

      Was this page helpful?