Create a form

POST/forms

Creates a draft form and returns it with a Location. name is required. Send pages and fields to author the whole form in one call, so fields can point at each other through conditions. Each field needs a type; put requiredness in validator, such as required|string. option_preset_id must be a live preset. status and type are read-only: POST /forms/{id}/actions/publish publishes. dry_run shows the result without saving it. Emits form.created and sends no email. DELETE /forms/{id} undoes it.

Query parameters

dry_runboolean#
Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

Idempotency-Keystring#
Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · FormCreate

namestringRequired#
The form's display name.
descriptionstring | null#
What the form is for.
pagesarray | null#
The form's pages.
fieldsarray | null#
The form's fields.

{
  "name": "Subscription Agreement",
  "description": "Subscription investment details and signature.",
  "pages": [
    {
      "name": "Investment",
      "order": 1
    }
  ],
  "fields": [
    {
      "type": "DROPDOWN",
      "label": "Marital status",
      "reference": "marital_status",
      "options": [
        "single",
        "married"
      ],
      "order": 1
    },
    {
      "type": "TEXT",
      "label": "Spouse name",
      "reference": "spouse_name",
      "order": 2,
      "conditions": [
        {
          "against_field_reference": "marital_status",
          "operator": "=",
          "value": "married"
        }
      ]
    }
  ]
}

Responses

201

The form was created.

Form

{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "name": "string",
    "description": "string",
    "type": "string",
    "status": "draft",
    "pages": [
      {
        "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "name": "string",
        "description": "string",
        "order": 1
      }
    ],
    "fields": [
      {
        "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "label": "string",
        "name": "string",
        "description": "string",
        "type": "string",
        "reference": "string",
        "validator": "string",
        "placeholder": "string",
        "pre_population_key": "string",
        "backfill": true,
        "order": 1,
        "page_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "option_preset_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "options": [],
        "required": true,
        "conditions": [],
        "condition_logic": "AND"
      }
    ],
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error

403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error

422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/forms\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "name": "Subscription Agreement",
  "description": "Subscription investment details and signature.",
  "pages": [
    {
      "name": "Investment",
      "order": 1
    }
  ],
  "fields": [
    {
      "type": "DROPDOWN",
      "label": "Marital status",
      "reference": "marital_status",
      "options": [
        "single",
        "married"
      ],
      "order": 1
    },
    {
      "type": "TEXT",
      "label": "Spouse name",
      "reference": "spouse_name",
      "order": 2,
      "conditions": [
        {
          "against_field_reference": "marital_status",
          "operator": "=",
          "value": "married"
        }
      ]
    }
  ]
}'