Skip to main content

CreateClientFieldRequest

Request schema for creating a client field

descriptionstringnullable

An optional description of the field.

keystringrequired

The machine-readable key for the field.

labelstringrequired

The human-readable label for the field.

options object

Options for choice-type client fields.

allow_otherboolean

Whether to allow a free-text "other" option.

choices object[]

The list of choices.

  • Array [
  • idstring

    Unique identifier for the choice.

    labelstringrequired

    The display label for the choice.

  • ]
  • sensitiveboolean

    Whether the field contains sensitive data.

    typestringrequired

    The field type.

    Possible values: [short_text, long_text, email, phone, boolean, radio, select, checkbox]

    CreateClientFieldRequest
    {
    "key": "company_name",
    "label": "Company Name",
    "type": "short_text"
    }