Update enrichment
update_enrichmentEdit an enrichment's name, prompt, budget, tools, and output columns—add, rename, change, pin, or delete columns—to keep dataset enrichments aligned with research needs.
Instructions
update enrichment
Edit an enrichment: name, prompt, input_columns, budget (credits per row; moves by 1.5 per output column added or removed unless budget_locked), only_tools / additional_tools, and output columns by name: a new name adds a column (type inferred unless output_schema is given), { "prompt", "output_schema" } changes one, { "tool": "<list_tools name>" } pins a tool to it — one call per row is the cell, the agent choosing the arguments (null unpins; help with pinned_columns), { "rename" } renames, { "delete": true } removes. Changed columns make dataset cells stale (re-run by the next enrich). 409 enrichment_in_use while a fill runs. Prefer update_dataset to change one dataset's columns. help with output_schema.
Example — Change one column's prompt, add a typed one: { "output": { "CEO": { "prompt": "Full name of the current CEO" }, "Employee count": { "prompt": "Current headcount as an integer", "output_schema": { "type": "integer", "minimum": 0 } } } }
Example — Rename a column, delete another: { "output": { "HQ": { "rename": "HQ city" }, "Old Column": { "delete": true } } }
Example — New prompt and budget: { "prompt": "Research each company's go-to-market motion", "budget": 8 }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The enrichment id (enr_...) | |
| name | No | Display name. An empty string clears it. | |
| budget | No | Credits the row agent may spend per row. Sent with column changes, it wins over the per-column adjustment. | |
| output | No | Output column edits keyed by column name. A name not on the enrichment adds a column; `prompt` / `output_schema` / `tool` change one (its filled cells read `stale`); `rename` renames it (cells kept); `delete: true` removes it. | |
| prompt | No | The task prompt the row agent reads for every row. | |
| only_tools | No | Exactly these tools (names from GET /tools). Replaces the default set. | |
| budget_locked | No | true keeps the budget as set when output columns are added or removed; false lets it move by 1.5 per column again. | |
| input_columns | No | The headers rows must carry when this enrichment runs (replaces the list; [] = any headers). Names only; no row data. | |
| additional_tools | No | The default tools plus these (e.g. linkedin_person_contact; custom_apollo_people_search once enabled on the account and your Apollo key is linked). See GET /v1/tools. |