APG PayAPG Paydocs

Reporting

Update report pin

PATCH/report-pins/{reportPinId}

Move a pin to another place in the caller's list.

Permissions

Required permission
reports:query

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

Path parameters

reportPinIdstring
required

Request body

This body is a tagged shape: type is always "RpinUpdateMove". Send it; more variants can be added, and a caller that switches on it keeps working when they are.

Discriminated by type
type = "RpinUpdateMove"
positioninteger (int32)required

Example 1250

curl -X PATCH https://api.tst.au.apgpay.dev/report-pins/{reportPinId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "RpinUpdateMove",
  "position": 1250
}'

Responses

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

Discriminated by type
type = "RpinUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "RpinUpdateRspAttributes",
  "updated": {
    "type": "RpinViewAttributes",
    "reportPinId": "rpin_9f2Kd8QpLzXw",
    "reportDashboardId": "rdsh_9f2Kd8QpLzXw",
    "position": 1250,
    "createdAt": "2026-08-19T04:21:07Z",
    "updatedAt": "2026-08-19T04:21:07Z"
  }
}

Error responses