Skip to main content

AgentClassificationConfig

Controls what the agent extracts from a conversation and stores on the lead.

collect_lead_timezoneCollect Lead Timezone

Run a dedicated collector that reads the lead's timezone from the conversation and stores it on the lead. Stops once a timezone is known.

Default value: false
collect_phoneCollect Phone

Run a dedicated collector that reads the lead's own phone number from the conversation. A collected number becomes a real phone contact on the lead rather than a classification field, and is mirrored to the CRM. It is stored in canonical form (country code and national number) and is never made the lead's main contact, so it does not become an outreach target on its own. Stops once the lead has any phone contact. To avoid a pointless call on every message, the collector runs only when the lead's own recent messages actually contain enough digits to be a number. It also picks up the lead's name when they give one in the same breath, and names the contacts it creates with it.

Default value: false
collect_emailCollect Email

Run a dedicated collector that reads the lead's own email address from the conversation. Works exactly like collect_phone: a collected address becomes a real email contact on the lead rather than a classification field, is mirrored to the CRM, and is never made the lead's main contact. It is stored lowercased. Stops once the lead has any email contact, and runs only when the lead's own recent messages contain something address-shaped — written, dictated, or obfuscated. Like collect_phone it also picks up the lead's name when they give one alongside the address.

Default value: false
classification_enabledClassification Enabled

Whether the agent extracts the configured fields from dialogues at all.

Default value: false
fields object[]

The fields to extract, each described in the agent's own words for the model to fill.

  • Array [
  • 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
  • ]
  • AgentClassificationConfig
    {
    "collect_lead_timezone": false,
    "collect_phone": false,
    "collect_email": false,
    "classification_enabled": false,
    "fields": [
    {
    "name": "string",
    "description": "string",
    "data_type": "string",
    "crm_field_id": 0,
    "can_update": true
    }
    ]
    }