Skip to main content
PATCH
Update a report's narrative overrides

Description

Update report narrative Draft-only. Validates the patch and shallow-merges it into the report’s stored narrative overrides — existing entries not named in the patch survive (blocks is whole-array replace-on-provided). Rejected with 409 Conflict once the report is finalized. Authorization:
  • Required role: admin or higher

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

id
string<uuid>
required

Body

application/json

Reports.narrative — one report's overrides on top of the tenant's reporting defaults. A PATCH shallow-merges terminology and sectionToggles key-by-key (existing entries not named in the patch survive); blocks is whole-array replace-on-provided; scalars overwrite when provided.

terminology
object

Keyed by the raw source label being relabeled.

sourceDisclosure
enum<string>
Available options:
named,
alias,
omit
sourceAliasText
string

Display text used when sourceDisclosure is alias.

Maximum string length: 120
sectionToggles
object

Boolean per section key: summary, monthly, byRelease, byTrack, byDSP, byTerritory, bySaleType, payments, reconciliation. Unset keys default to visible.

blocks
object[]

Response

Report narrative updated.

Every /reports JSON response wraps its payload in { status, message, data }.

status
enum<string>
Available options:
success,
error
message
string
data
object