---
title: "Save a generated form"
method: POST
path: "/formbuilder/saveForm"
tags: ["Form Builder"]
---

# Save a generated form

`POST /formbuilder/saveForm`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/formbuilder/saveForm`
- Auth: none declared

Saves a generated form with its data.

## Request body

- object
  - `formData` FormbuilderFormDocument: A form document
    - `_id` string
    - `name` string, required
    - `groups` FormbuilderFormDocumentGroupsItems[]
      - union
        - string
        - object
    - `created` string, date-time
    - `created_by` unknown
    - `last_updated` string, date-time
    - `last_updated_by` unknown
    - `elements` FormbuilderFormDocumentElementsItems[], required
      - `type` string, required
      - `id` FormbuilderFormDocumentElementsItemsId, required
        - `name` string, required
    - `children` FormbuilderFormDocumentChildrenItems[], required
      - `id` string, required
      - `element` string
      - `type` string, required
      - `name` string
      - `display_name` string
      - `source_type` 'service_model' | 'custom' | 'method'
      - `source` string
      - `key` string
      - `properties` FormbuilderFormDocumentChildrenItems, required (recursive)

## Response `200`

Status of save form

- FormbuilderFormDocument: A form document
  - `_id` string
  - `name` string, required
  - `groups` FormbuilderFormDocumentGroupsItems[]
    - union
      - string
      - object
  - `created` string, date-time
  - `created_by` unknown
  - `last_updated` string, date-time
  - `last_updated_by` unknown
  - `elements` FormbuilderFormDocumentElementsItems[], required
    - `type` string, required
    - `id` FormbuilderFormDocumentElementsItemsId, required
      - `name` string, required
  - `children` FormbuilderFormDocumentChildrenItems[], required
    - `id` string, required
    - `element` string
    - `type` string, required
    - `name` string
    - `display_name` string
    - `source_type` 'service_model' | 'custom' | 'method'
    - `source` string
    - `key` string
    - `properties` FormbuilderFormDocumentChildrenItems, required (recursive)

## Other responses

- `500`: Error response from API

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)