Delete a lead field
delete_lead_fieldDelete a lead field
Removes a custom field from the agent's lead form permanently. Leads keep the values they
had under its key: the API still returns them in custom_fields, the dashboard's table
stops showing them, and they show again if a field with the same key is added. The AI
stops collecting the field in the background, usually within a minute. Built-in fields
can't be deleted (422 system_field).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agent_id | Yes | The agent the resource belongs to. Another company's agent, or the nil UUID, is `404 agent_not_found`; an agent outside the key's agent list is `403 agent_not_authorized`. | |
| field_key | Yes | A lead field's `key`, as `listLeadFields` returns it, matched exactly (case included). A key the agent has no field for is `404 not_found`. |