Reports

Update a report in place

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.

patch/reports/{id}

Request

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

Request body

titlestring

Non-empty.

descriptionstring nullable

null clears it.

htmlstring

Non-empty, max 5 MB. Appends a revision (deduped when the content hash is unchanged).

producer_namestring nullable
producer_urlstring nullable

http(s) only.

producer_icon_urlstring nullable

http(s) only.

source_recipeobject nullable

Response

Updated report summary.

idstring uuid required
titlestring required
descriptionstring nullable
updated_atstring date-time required
head_revision_idstring uuid nullable
edit_urlstring required
share_urlstring required

Changes

No recorded changes to this operation across all 1 revision of this API.