/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

3 body

3 total

Body · 3

codestringRequired

Current form code (used to find the form).

infoobjectRequired4 fields

fieldsobject[]Required9 fields

Request

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
    }
  ]
}'

Response

JSON payload

{
  "success": false
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key