Skip to main content
PATCH
Preview. This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive 403 mcp_not_enabled. See the preview overview.
Changes one column of a report. Send only the fields you want to change. Fields you leave out keep their current value. Changing prompt, type or options makes the column’s answers out of date. On a report created through the API over files, every cell in the column goes back to empty until the next run; cells a person reviewed in the app keep their answer. A report that computes straight away (one that follows a repository, or one made in the app with auto-run on) recomputes the column. Changing only name keeps the cells as they are. This endpoint is REST only.

​
Authentication

Requires an API key, or an OAuth token with reports:write. The caller also needs edit access to the report.

​
Path parameters

​
string
required
The report id.
​
string
required
The column id.

​
Body parameters

​
string
The new column header.
​
string
The new question. Its cells go out of date, or are recomputed on a report that computes automatically.
​
string
The new answer type: text, number, date, boolean, single_select or multi_select. Its cells go out of date, or are recomputed on a report that computes automatically.
​
string[]
The allowed answers of a single_select or multi_select column, at least one. They replace the current ones. Required when you change type to a select type. An empty list is refused with 400: a select column always has answers to choose from.
Changing prompt, type or options invalidates the column’s answers. On most reports its cells read empty until the next run. On a report that computes automatically, such as one that follows a repository or one built in the app, the column is recomputed straight away and uses credits, as editing it in the app does.

​
Response

Returns 200 with the updated column.

​
Errors