APG PayAPG Paydocs

Operations

Update feature flag

PATCH/feature-flags/{featureFlagId}

Change who a flag is on for: set its mode, or add to or take from its tenants or its people. Answers with the flag as it now is.

5 actionsFflagUpdateAddTenantsFflagUpdateAddUsersFflagUpdateModeFflagUpdateRemoveTenantsFflagUpdateRemoveUsers

Permissions

Required permission
queues:update

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

Path parameters

featureFlagIdstring
required

Request body

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

Discriminated by type
type = "FflagUpdateAddTenants"
tenantsarray of stringrequired
curl -X PATCH https://api.tst.au.apgpay.dev/feature-flags/{featureFlagId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "FflagUpdateAddTenants",
  "tenants": [
    "string"
  ]
}'

Responses

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

Discriminated by type
type = "FflagUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "FflagUpdateRspAttributes",
  "updated": {
    "type": "FflagViewAttributes",
    "featureFlagId": "string",
    "description": "string",
    "mode": "Off",
    "tenants": [
      "string"
    ],
    "users": [
      "string"
    ],
    "saved": true,
    "heldClosed": true,
    "version": 1250,
    "updatedAt": "2026-08-19T04:21:07Z",
    "updatedBy": "string"
  }
}

Error responses