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 bodyrequired

namestringrequired
Required. Display name. 1-255 characters
slugstringrequired
Required. URL-friendly identifier, unique per site and locale. 1-255 characters
localestring
BCP 47 locale code (e.g. "en", "fr")
schemaobjectrequired
Required. Field schema definition
- pagesarray<object>
  - titlestring
  - fieldsarray<string>required
  - descriptionstring
- fieldsarray<object>required
  - idstringrequired
  - typeenumrequired
    One of: textemailteltextareaselectcheckboxradiodatedatetimetimenumberfileratinghidden
  - labelstringrequired
  - widthenum
    One of: fullhalfthird
  - optionsarray<object>
    - labelstringrequired
    - valuestringrequired
  - requiredboolean
  - conditionsarray<object>
    - fieldstringrequired
    - valueany
    - actionenumrequired
      One of: showhiderequireskip_to_page
    - operatorenumrequired
      One of: equalsnot_equalscontainsnot_containsgreater_thanless_thanis_emptyis_not_empty
    - targetPagenumber
  - validationobject
    - maxnumber
    - minnumber
    - acceptstring
    - maxSizenumber
    - patternstring
    - maxLengthnumber
    - minLengthnumber
  - descriptionstring
  - placeholderstring
  - defaultValueany
- settingsobject
  - redirectUrlstring
  - requireAuthboolean
  - submitLabelstring
  - closedMessagestring
  - successMessagestring
  - showProgressBarboolean
- conditionsarray<object>
  - fieldstringrequired
  - valueany
  - actionenumrequired
    One of: showhiderequireskip_to_page
  - operatorenumrequired
    One of: equalsnot_equalscontainsnot_containsgreater_thanless_thanis_emptyis_not_empty
  - targetPagenumber
statusenum
One of: draft, active, closed, archived
One of: draftactiveclosedarchived
settingsobject
Configuration settings
descriptionstring
Description text. Max 1000 characters
notificationsobject
Notification preferences
- emailobject
  - toarray<string>required
  - enabledbooleanrequired
  - replyTostring
  - subjectstring
  - templatestring
- webhookobject
  - urlstringrequired
  - methodenum
    One of: POSTPUT
  - enabledbooleanrequired
  - headersobject
  - retryCountnumber
honeypotEnabledboolean
Boolean
recaptchaEnabledboolean
Boolean
recaptchaSiteKeystring
Max 255 characters
recaptchaSecretKeystring
Max 255 characters

View as markdown Install Lynkow Skills

curl --request POST \
  --url 'https://api.lynkow.com/v1/forms' \
  --header 'Authorization: Bearer $API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "data": {
    "id": 3,
    "name": "Contact Form",
    "slug": "contact-form",
    "locale": "en",
    "schema": [
      {
        "name": "name",
        "type": "text",
        "label": "Full Name",
        "required": true
      },
      {
        "name": "email",
        "type": "email",
        "label": "Email",
        "required": true
      },
      {
        "name": "message",
        "type": "textarea",
        "label": "Message",
        "required": true
      }
    ],
    "status": "active",
    "createdAt": "2025-04-06T11:00:00.000Z",
    "updatedAt": "2025-04-06T11:00:00.000Z",
    "redirectUrl": null,
    "successMessage": "Thank you for reaching out!",
    "submissionCount": 0
  }
}

Feedback

Request bodyrequired

Was this page helpful?