APG PayAPG Paydocs

Reference data

Update named list

PATCH/named-lists/{namedListId}

Add entries to a list and take entries from it, as its next version. An edit that changes nothing writes no version.

Permissions

Required permission
rules:update

Requires the `update` action on `rules` for the supplied runtime context

Path parameters

namedListIdstring
required

Request body

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

Discriminated by type
type = "NlstUpdateEdit"
expectedVersioninteger (int32)required

The version the caller last read. A change to any other version is refused with 409.

Example 1250

The entries an edit adds to a list and takes from it.

reasonstring

Example Requested by the customer.

curl -X PATCH https://api.tst.au.apgpay.dev/named-lists/{namedListId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "NlstUpdateEdit",
  "expectedVersion": 1250,
  "entries": {
    "type": "NlstEntryEditAttributes",
    "add": [
      "string"
    ],
    "remove": [
      "string"
    ]
  },
  "reason": "Requested by the customer."
}'

Responses

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

Discriminated by type
type = "NlstUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "NlstUpdateRspAttributes",
  "updated": {
    "type": "NlstViewAttributes",
    "namedListId": "nlst_9f2Kd8QpLzXw",
    "name": "Ada Lovelace",
    "domain": "string",
    "owner": {
      "type": "RpolOwnerEnterprise",
      "enterpriseId": "ent_9f2Kd8QpLzXw"
    },
    "kind": "string",
    "description": "string",
    "version": 1250,
    "createdAt": "2026-08-19T04:21:07Z",
    "createdBy": "string",
    "updatedAt": "2026-08-19T04:21:07Z",
    "retiredAt": "2026-08-19T04:21:07Z"
  }
}

Error responses