/bff/contact/custom-field/definition-save

Creates or updates a custom field definition. Uses upsert on key + organisation.

ContactpostBffContactCustom-fieldDefinition-save

Parameters

JSON body

Request body

application/json

keystringRequired

Unique field key identifier.

Examplecompany_size

typestringRequired

Field data type.

Examplestextnumberselect

labelstringRequired

Display label for the field.

helperTextstringOptional

Help text shown below the field.

placeholderstringOptional

Placeholder text for the input.

requiredbooleanRequired

Whether the field is required.

activebooleanRequired

Whether the field is active and visible.

validationPatternstringOptional

Regex validation pattern.

positionnumberRequired

Sort order position.

Response schema

1 status code documented

200Success

successbooleanRequired

Default: true

Response example

application/json

{
  "success": true
}

Request example

POST /bff/contact/custom-field/definition-save

post

curl -X POST "https://api.bizkithub.com/bff/contact/custom-field/definition-save" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "key": "company_size",
  "type": "text",
  "label": "example_label",
  "helperText": "example_helperText",
  "placeholder": "example_placeholder",
  "required": false,
  "active": false,
  "validationPattern": "example_validationPattern",
  "position": 0
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key