---
title: "Update a report in place"
method: PATCH
path: "/reports/{id}"
tags: ["Reports"]
---

# Update a report in place

`PATCH /reports/{id}`

## Request

- Base URL: `https://commareports.com/api/v1`
- URL: `https://commareports.com/api/v1/reports/{id}`
- Auth: HTTP bearer

Update `title`, `description`, and/or `html` (plus producer attribution fields). New HTML appends a revision — the share URL is stable. Requires edit access (`can_edit_report`: owner, admin, or editor) — 403 otherwise. Encrypted reports return 409. Scope: `reports:write`.

## Request body

- ReportPatchRequest: At least one property must be present.
  - `title` string: Non-empty.
  - `description` string, nullable: null clears it.
  - `html` string: Non-empty, max 5 MB. Appends a revision (deduped when the content hash is unchanged).
  - `producer_name` string, nullable
  - `producer_url` string, nullable: http(s) only.
  - `producer_icon_url` string, nullable: http(s) only.
  - `source_recipe` object, nullable

## Response `200`

Updated report summary.

- ReportPatched
  - `id` string, uuid, required
  - `title` string, required
  - `description` string, nullable
  - `updated_at` string, date-time, required
  - `head_revision_id` string, uuid, nullable
  - `edit_url` string, required
  - `share_url` string, required

## Other responses

- `400`: Malformed body or invalid field.
- `401`: Missing, invalid, revoked, or expired token.
- `403`: Token missing the required scope, or no access to the resource.
- `409`: Report is encrypted; use the ciphertext endpoints instead.
- `413`: Payload exceeds a size limit (HTML > 5 MB; asset > 25 MB per file or > 250 MB per report).
- `429`: Rate limit exceeded. Rate limit: per-token sliding window (plan-aware — Free 60 req/min, Pro 600, Team/Enterprise 6000 by default); 429 responses carry a Retry-After header.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/commareports/apis/comma-api.md) · [All operations](https://skmtc.dev/commareports/apis/comma-api/llms.txt) · [OpenAPI document](https://skmtc.dev/commareports/apis/comma-api/revisions/cd5263522ade?raw)