APG PayAPG Paydocs

Reporting

Update report space

PATCH/report-spaces/{reportSpaceId}

Rename, move or share a space the caller may change. Sharing one, or changing a shared one, needs Reports_Manage as well, and the System space keeps its name and place.

4 actionsRspcUpdateMoveRspcUpdateMoveToTopRspcUpdateRenameRspcUpdateShare

Permissions

Required permission

Required action depends on the request variant. Select a variant in the request body below to see the permission it requires.

Path parameters

reportSpaceIdstring
required

Request body

This body is a typed union. Pick a variant to see its fields, the permission it requires, and a matching example.

Discriminated by type
type = "RspcUpdateMove"
Required permission
reports:query

Move a space into another

parentReportSpaceIdRspcIdrequired

Identifier of a report space.

Example rspc_9f2Kd8QpLzXw

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

Responses

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

Discriminated by type
type = "RspcUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "RspcUpdateRspAttributes",
  "updated": {
    "type": "RspcViewAttributes",
    "reportSpaceId": "rspc_9f2Kd8QpLzXw",
    "name": "Ada Lovelace",
    "access": "Private",
    "parentReportSpaceId": "rspc_9f2Kd8QpLzXw",
    "tenant": {
      "type": "RspcTenantEnterprise",
      "enterpriseId": "ent_9f2Kd8QpLzXw"
    },
    "ownedByCaller": true,
    "editable": true,
    "isDefault": true,
    "createdAt": "2026-08-19T04:21:07Z",
    "updatedAt": "2026-08-19T04:21:07Z",
    "icon": "string"
  }
}

Error responses