APG PayAPG Paydocs

Reporting

Update report notebook

PATCH/report-notebooks/{reportNotebookId}

Rename, move or rewrite a notebook the caller may change. Changing one in a shared space needs Reports_Manage as well.

3 actionsRnbkUpdateMoveRnbkUpdateRenameRnbkUpdateReplaceCells

Permissions

Required permission
reports:query

Requires the `query` action on `reports` for the supplied runtime context

Path parameters

reportNotebookIdstring
required

Request body

This body is a typed union. Pick a variant to see its fields and a matching example.

Discriminated by type
type = "RnbkUpdateMove"
reportSpaceIdRspcIdrequired

Identifier of a report space.

Example rspc_9f2Kd8QpLzXw

curl -X PATCH https://api.tst.au.apgpay.dev/report-notebooks/{reportNotebookId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "RnbkUpdateMove",
  "reportSpaceId": "rspc_9f2Kd8QpLzXw"
}'

Responses

The response is a tagged shape: type is always "RnbkUpdateRspAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "RnbkUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "RnbkUpdateRspAttributes",
  "updated": {
    "type": "RnbkViewAttributes",
    "reportNotebookId": "rnbk_9f2Kd8QpLzXw",
    "reportSpaceId": "rspc_9f2Kd8QpLzXw",
    "title": "string",
    "cells": [
      {
        "type": "RnbkCellHidden",
        "cellId": "string"
      }
    ],
    "access": "Private",
    "tenant": {
      "type": "RspcTenantEnterprise",
      "enterpriseId": "ent_9f2Kd8QpLzXw"
    },
    "ownedByCaller": true,
    "editable": true,
    "createdAt": "2026-08-19T04:21:07Z",
    "updatedAt": "2026-08-19T04:21:07Z"
  }
}

Error responses