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

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

ContactpostBffContactCustom-fieldDefinition-save

Parameters

9 body

9 total

Body · 9

keystringRequired

Unique field key identifier.

typestringRequired

Field data type.

labelstringRequired

Display label for the field.

helperTextstring

Help text shown below the field.

placeholderstring

Placeholder text for the input.

requiredbooleanRequired

Whether the field is required.

activebooleanRequired

Whether the field is active and visible.

validationPatternstring

Regex validation pattern.

positionnumberRequired

Sort order position.

Request

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

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key