---
title: "Update a form"
method: PUT
path: "/json-forms/forms/{id}"
tags: ["JSON Forms"]
---

# Update a form

`PUT /json-forms/forms/{id}`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/json-forms/forms/{id}`
- Auth: none declared

Updates a previously created JSON form, based on a supplied document ID and an object of fields to update.

## Path parameters

- `id` string, required

## Request body

- object
  - `options` JsonFormsFormDocumentForm
    - `_id` string
    - `created` string, date-time, required
    - `createdBy` string, required
    - `lastUpdated` string, date-time, required
    - `lastUpdatedBy` string, required
    - `name` string, required
    - `tags` JsonFormsFormDocumentFormTagsItems[]
      - union
        - string
        - object
    - `description` string, nullable, required
    - `struct` JsonFormsFormDocumentFormStruct, required
      - `nodeId` string
      - `projectId` string
      - `type` string, required
      - `items` JsonFormsFormDocumentFormStructItemsItems[], required
        - union
          - JsonFormsFormDocumentFormStructItemsItems0
            - `nodeId` string, required
            - `type` string, required
            - `title` string, required
            - `required` union
              - …
            - `options` JsonFormsFormDocumentFormStructItemsItemsOneOf0Options
            - `description` string
            - `helper` string
            - `items` JsonFormsFormDocumentFormStructItemsItemsOneOf0ItemsItems[], required
              - …
            - `collapsed` boolean
            - `readOnly` boolean
            - `schemaOption` boolean
            - `combinationType` string
            - `widget` string
            - `uniqueItems` boolean
            - `minItems` number, double
            - `maxItems` number, double
            - `customKey` union
              - …
          - JsonFormsFormDocumentFormStructItemsItems1
            - `nodeId` string, required
            - `customKey` union
              - …
            - `type` 'boolean', required
            - `required` boolean
            - `options` JsonFormsFormDocumentFormStructItemsItemsOneOf1Options
            - `title` string, required
            - `description` string, required
            - `helper` string
            - `default` boolean
            - `enum` JsonFormsFormDocumentFormStructItemsItemsOneOf1EnumItems[]
              - …
            - `readOnly` boolean
            - `widget` string
          - JsonFormsFormDocumentFormStructItemsItems2
            - `customKey` union
              - …
            - `nodeId` string, required
            - `type` 'number', required
            - `widget` string
            - `options` JsonFormsFormDocumentFormStructItemsItemsOneOf2Options
            - `title` string, required
            - `description` string, required
            - `helper` string
            - `placeholder` string, required
            - `required` boolean, required
            - `validation` union
              - …
            - `readOnly` boolean
            - `minimum` number, double, nullable
            - `maximum` number, double, nullable
            - `default` number, double, nullable
            - `disabled` boolean
          - JsonFormsFormDocumentFormStructItemsItems3
            - `nodeId` string, required
            - `type` 'string', required
            - `customKey` union
              - …
            - `title` string, required
            - `options` JsonFormsFormDocumentFormStructItemsItemsOneOf3Options
            - `description` string, required
            - `helper` string
            - `placeholder` string, required
            - `required` boolean, required
            - `pattern` string
            - `validation` union
              - …
            - `readOnly` boolean
            - `binding` boolean
            - `rel` string
            - `targetPointer` string
            - `format` string
            - `minLength` integer
            - `maxLength` integer
            - `default` string
            - `disabled` boolean
          - JsonFormsFormDocumentFormStructItemsItems4
            - `customKey` union
              - …
            - `nodeId` string, required
            - `type` 'string', required
            - `widget` string
            - `title` string, required
            - `options` JsonFormsFormDocumentFormStructItemsItemsOneOf4Options
            - `description` string, required
            - `helper` string
            - `placeholder` string, required
            - `required` boolean, required
            - `pattern` string
            - `validation` union
              - …
            - `readOnly` boolean
            - `format` string
            - `minLength` integer
            - `maxLength` integer
            - `default` string
            - `disabled` boolean
          - JsonFormsFormDocumentFormStructItemsItems5
            - `nodeId` string, required
            - `type` string, required
            - `customKey` union
              - …
            - `title` string, required
            - `options` JsonFormsFormDocumentFormStructItemsItemsOneOf5Options
            - `description` string, required
            - `helper` string
            - `placeholder` string
            - `required` boolean, required
            - `enum` JsonFormsFormDocumentFormStructItemsItemsOneOf5EnumItems[]
              - …
            - `enumNames` JsonFormsFormDocumentFormStructItemsItemsOneOf5EnumNamesItems[]
              - …
            - `binding` boolean
            - `pattern` string
            - `rel` string
            - `targetPointer` string
            - `method` string, nullable
            - `body` JsonFormsFormDocumentFormStructItemsItemsOneOf5Body
            - `sourcePointer` string, nullable
            - `sourceKeyPointer` string, nullable
            - `labelKeyPointer` string, nullable
            - `base` string, nullable
            - `href` string, nullable
            - `validation` union
              - …
            - `readOnly` boolean
            - `transformation` union
              - …
            - `disabled` boolean
            - `default` union
              - …
            - `widget` string
            - `radio` boolean
            - `inline` boolean
          - JsonFormsFormDocumentFormStructItemsItems6
            - `nodeId` string, required
            - `type` 'string', required
            - `title` string, required
            - `description` string, required
            - `helper` string
            - `required` boolean
            - `format` 'data-url'
            - `customKey` union
              - …
    - `schema` JsonFormsFormDocumentFormSchema, required
      - `_id` string
      - `uniqueItems` boolean
      - `minItems` number, double
      - `maxItems` number, double
      - `type` string, required
      - `title` string, required
      - `description` string
      - `required` string[]
      - `readOnly` boolean
      - `options` JsonFormsFormDocumentFormSchemaOptions
      - `properties` JsonFormsFormDocumentFormSchema (recursive)
      - `items` JsonFormsFormDocumentFormSchemaItems
      - `anyOf` JsonFormsFormDocumentFormSchemaItems[]
      - `oneOf` JsonFormsFormDocumentFormSchemaOneOfItems[]
      - `allOf` JsonFormsFormDocumentFormSchemaItems[]
    - `uiSchema` JsonFormsFormDocumentFormUiSchema, required
    - `validationSchema` JsonFormsFormDocumentFormValidationSchema, required
    - `bindingSchema` JsonFormsFormDocumentFormBindingSchema, required
    - `version` string, required
    - `id` string
    - `namespace` JsonFormsFormDocumentFormNamespace
      - `type` unknown
      - `_id` string
      - `name` string
      - `accessControl` JsonFormsFormDocumentFormNamespaceAccessControl
        - `read` string[]
        - `execute` string[]
        - `write` string[]
        - `manage` string[]

## Response `200`

A response object containing the request status and a message

- JsonFormsUpdateFormResponse200
  - `status` 'success' | 'failure'
  - `message` string

## Other responses

- `500`: Error response from API

## Changes

- **2026-10-31** `2095cc90e583`: 2 info
  - api tag `JSON Forms` added
  - api tag `jsonForms` removed

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/json-forms/forms/:id/put.md)

---

[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)