/bff/form/rename-field-key

Renames a field key (the programmatic identifier). If the new key conflicts with an existing field, a numeric suffix is appended. Does not affect existing submitted records.

FormpostBffFormRename-field-key

Parameters

JSON body

Request body

application/json

formCodestringRequired

Form code.

Examplecontact-form

fieldCodestringRequired

Current field key.

Examplefield_1

fieldCodeNewstringRequired

New field key. Auto-suffixed if it conflicts with another field.

Exampleemail

Response schema

1 status code documented

200Success

successbooleanRequired

Response example

application/json

{
  "success": false
}

Request example

POST /bff/form/rename-field-key

post

curl -X POST "https://api.bizkithub.com/bff/form/rename-field-key" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "formCode": "contact-form",
  "fieldCode": "field_1",
  "fieldCodeNew": "email"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key