Skip to main content
PATCH
Rename a smart column, change its prompt or providers

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Path Parameters

listId
string
required

Id of the list that owns the smart column.

columnId
string
required

Id of the smart column, as returned when it was created or listed by GET /business/lists/{listId}/columns.

Body

application/json
name
string

New display name (1-100 characters, trimmed). Must stay unique on the list and must not be a reserved built-in column name.

Required string length: 1 - 100
prompt
string

New research instruction (1-2000 characters, trimmed). Changing the prompt immediately recomputes the rows the column has already computed (plus cells a cancelled run left pending or running), cancelling any run in progress and billing each recomputed row at the column's per-row credit rate.

Required string length: 1 - 2000
providerIds
string[] | null

deep_research columns only: replace the provider restriction with these provider ids — the id values returned by GET /business/research/providers — or null to clear it and let the column use every provider available to your workspace. The ids are an allowlist, not an order: the run may call any of them, chooses per row, and need not use them all; the order you send them in is ignored. Send 1 to 50 distinct ids — an empty array or a repeated id is rejected. Ids are never checked against the catalog: a typo, a provider whose allowedInRuns is false, or a byok-required provider you have not saved a key for is accepted and then silently dropped from the run, and if none of the ids survive that check the rows are researched only by the providers Fuse always includes, so the answers come back far thinner than you asked for with no error anywhere. The new selection is free, recomputes nothing on its own and applies from the next run; sent for a standard-engine column it is rejected with 422 PROVIDERS_NOT_SUPPORTED.

Required array length: 1 - 50 elements

A Deep Research provider id: the id (catalog slug, for example zerobounce) of an entry returned by GET /business/research/providers, not a Mongo id.

Required string length: 1 - 64

Response

Success

column
object
required
jobId
string | null
required

Id of the billed re-run a prompt change started; null when nothing was recomputed (a rename, a provider change, or a prompt edit with no computed row left to refresh).