BizKitHub
DocsAPI ReferenceForm/bff/form/update-structure
postFormAdmin BFF

/bff/form/update-structure

Updates form metadata and all field definitions in a single request. Only fields with matching keys are updated — unknown keys are skipped. If the new code conflicts with another form, a numeric suffix is appended automatically.

FormpostBffFormUpdate-structure

Parameters

JSON body

Request body

application/json
codestringRequired

Current form code (used to find the form).

Examplecontact-form
infoobjectRequired
namestringRequired

New form name.

Length: 1–∞
ExampleContact Form
codestringRequired

New form code. Auto-suffixed if it conflicts with another form.

Examplecontact-form
activebooleanRequired

Whether the form is active.

Exampletrue
descriptionstringOptional

Form description.

ExampleGeneral inquiry form
fieldsobject[]Required
Each array item:
keystringRequired

Field key (must match an existing field).

Exampleemail
typestringRequired

Field input type (text, textarea, select, date, etc.).

Exampletext
labelstringRequired

Field label.

ExampleEmail address
helperTextstringOptional

Helper text below the field.

ExampleEnter your work email
requiredbooleanRequired

Whether the field is required.

Exampletrue
defaultValuestringOptional

Default value.

Example
optionsobjectRequired

Options for select/radio fields (key → label).

activebooleanRequired

Whether the field is active.

positionnumberRequired

Display order (0-based).

Response schema

1 status code documented

200Success
successbooleanRequired

Response example

application/json
{
  "success": false
}

Request example

POST /bff/form/update-structure

post
curl -X POST "https://api.bizkithub.com/bff/form/update-structure" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "code": "contact-form",
  "info": {
    "name": "Contact Form",
    "code": "contact-form",
    "active": true,
    "description": "General inquiry form"
  },
  "fields": [
    {
      "key": "email",
      "type": "text",
      "label": "Email address",
      "helperText": "Enter your work email",
      "required": true,
      "defaultValue": "",
      "options": {},
      "active": false,
      "position": 0
    }
  ]
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key