---
title: "Change a saved Hive report: its title, description, date period, channels or widgets. This never sends or shares anything."
method: POST
path: "/api/v1/tools/update_report"
---

# Change a saved Hive report: its title, description, date period, channels or widgets. This never sends or shares anything.

`POST /api/v1/tools/update_report`

## Request

- Base URL: `https://hivepublish.com`
- URL: `https://hivepublish.com/api/v1/tools/update_report`
- Auth: HTTP bearer

## Headers

- `Idempotency-Key` string, required

## Request body

- object
  - `reportId` string, required: The Hive report id.
  - `title` string
  - `description` string
  - `dateFrom` string: Inclusive report start as YYYY-MM-DD. Always use with dateTo for explicit dates; do not calculate epoch values.
  - `dateTo` string: Inclusive report end as YYYY-MM-DD. Use with dateFrom.
  - `datePeriod` object
    - `preset` 'thisMonth' | 'lastMonth' | 'thisWeek' | 'lastWeek' | 'last30' | 'custom'
    - `from` number: Epoch milliseconds, for a custom period.
    - `to` number: Epoch milliseconds, for a custom period.
  - `channelIds` string[]: Hive channel ids this report covers.
  - `widgets` object[]: The full widget list, as read_report returns it.
  - `internalNotes` string
  - `coverUrl` string, nullable: Hive report cover image URL; null removes the cover.
  - `branding` object: Hive report colors and header/footer notes. Use upload_report_logo to change the logo.

## Response `200`

Tool result

- ToolResult
  - `data` unknown, required
  - `meta` object, required
    - `tool` string
    - `workspaceId` string, uuid

## Other responses

- `400`: Invalid input
- `401`: Missing or invalid credential
- `403`: Missing workspace scope, role permission, or plan entitlement
- `409`: Idempotency conflict, replay, or request still in progress
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/hivepublish/apis/hive-developer-api.md) · [All operations](https://skmtc.dev/hivepublish/apis/hive-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hivepublish/apis/hive-developer-api/revisions/b440c763583e?raw)