Update Report

Rename a report or change its description.

PATCH /api/v1/reports/{report_id}

cURL

curl -X PATCH "https://api.wordsmith.ai/api/v1/reports/f544ddfc-24d5-4947-939c-ba2d1bcba35b" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Lease abstract: retail and office estate"
  }'

Response

{
  "id": "f544ddfc-24d5-4947-939c-ba2d1bcba35b",
  "name": "Lease abstract: retail and office estate",
  "description": "Key terms for every signed retail lease.",
  "repository_id": "b23066a1-44cb-4b31-8b44-c723dc507d9b",
  "row_count": 214,
  "column_count": 3,
  "status": "idle",
  "url": "https://app.wordsmith.ai/reports/f544ddfc-24d5-4947-939c-ba2d1bcba35b",
  "created_at": "2026-10-13T09:20:00Z",
  "updated_at": "2026-10-13T10:02:41Z"
}

Preview. This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive 403 mcp_not_enabled. See the preview overview.

Changes a report’s name or description. Send only the fields you want to change. Fields you leave out keep their current value. Set description to null to clear it.

To change the grid itself, use the column and row endpoints. A report’s row source (repository_id or files) is fixed when it is created.

Authentication

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

Path parameters

report_id · string · required

The report id.

Body parameters

name · string

The new name, up to 200 characters.

description · string | null

The new description, or null to clear it.

Response

Returns 200 with the updated report, without columns.

cURL

curl -X PATCH "https://api.wordsmith.ai/api/v1/reports/f544ddfc-24d5-4947-939c-ba2d1bcba35b" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Lease abstract: retail and office estate"
  }'

Response

{
  "id": "f544ddfc-24d5-4947-939c-ba2d1bcba35b",
  "name": "Lease abstract: retail and office estate",
  "description": "Key terms for every signed retail lease.",
  "repository_id": "b23066a1-44cb-4b31-8b44-c723dc507d9b",
  "row_count": 214,
  "column_count": 3,
  "status": "idle",
  "url": "https://app.wordsmith.ai/reports/f544ddfc-24d5-4947-939c-ba2d1bcba35b",
  "created_at": "2026-10-13T09:20:00Z",
  "updated_at": "2026-10-13T10:02:41Z"
}

Errors

Status	error_code	When
400	invalid_request_body	The body sets no field, name is null, or name is empty or longer than 200 characters.
403	forbidden	The caller can read the report but cannot edit it.
404	resource_not_found	No report with this id, or the caller cannot read it.