Skip to main content

ClassificationField

One CRM field an agent is asked to fill from the conversation.

nameNamerequired

The CRM field's name. Also the key it is stored and read under.

descriptionDescriptionrequired

What the agent should look for. Shown to the extraction model.

data_typeData Type

Legacy type hint. Superseded by the referenced CRM field definition wherever one exists — the definition owns the type and the option set.

Default value: string
crm_field_id object

The CRM field definition this fills, when it has been linked to one. Optional; a field is matched by name when it is absent.

anyOf
integer
can_updateCan Update

Whether the agent may overwrite a value that is already there. Filling an empty field needs no permission — listing the field here is that permission. Defaults to true.

Default value: true
ClassificationField
{
  "name": "string",
  "description": "string",
  "data_type": "string",
  "crm_field_id": 0,
  "can_update": true
}