Update rule policy

PATCH/rule-policies/{rulePolicyId}

Make the next version of a policy, or take a step of the maker and checker flow: submit, approve or reject a version, pause, resume or retire the rule.

9 actionsRpolUpdateApproveRpolUpdatePauseRpolUpdateRejectRpolUpdateResumeRpolUpdateRetireRpolUpdateReviseRpolUpdateRollBackRpolUpdateSetModeRpolUpdateSubmit

Permissions

Required permission

rules:update

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

Path parameters

rulePolicyIdstring

required

Request body

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

Discriminated by type

type = "RpolUpdateApprove"

expectedVersioninteger (int32)required

Example 1250

reasonCodeRpolReasonrequired

NewTypologyTuningRegulatoryChangeIncidentResponseCorrectionRollbackScheduledReviewImportUnknown

reasonstring

Example Requested by the customer.

curl -X PATCH https://api.tst.au.apgpay.dev/rule-policies/{rulePolicyId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "RpolUpdateApprove",
  "expectedVersion": 1250,
  "reasonCode": "NewTypology",
  "reason": "Requested by the customer."
}'

Responses

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

Discriminated by type

type = "RpolUpdateRspAttributes"

The resource as it stands after the change.

typeenumrequired

RpolViewAttributes

rulePolicyIdRpolIdrequired

Identifier of a rule policy.

Example rpol_9f2Kd8QpLzXw

domainstringrequired

The area the rule belongs to, as ruleAreaId names it.

stateRpolStaterequired

The state of the current version.

DraftPendingApprovalApprovedRejectedUnknown

modeRpolModerequired

ShadowEnforcingUnknown

pausedbooleanrequired

Whether the rule is switched off without being retired.

Example true

A rule: the template it is made from, and the value of each of the template's parameters. A parameter left out takes the template's default. The action is the one the template and its values take, so it is returned and never sent.

typeenumrequired

RpolRuleAttributes

templateIdstringrequired

The template's id, as the area's description names it.

typeenumrequired

RpolArgumentAttributes

parameterIdstringrequired

The parameter's id, as the area's description names it.

The action the rule takes when it matches. Read only: a rule's template and values decide it.

templateVersioninteger (int32)required

The version of its template the rule was made with, which it keeps for as long as the policy holds it.

Example 1250

descriptionstring

versioninteger (int32)required

The current version, which a change names as expectedVersion.

Example 1250

effectiveFromstring (date-time)required

When the rule takes effect.

Example 2026-08-19T04:21:07Z

effectiveUntilstring (date-time)

When the rule stops taking effect. Absent for one that does not.

Example 2026-08-19T04:21:07Z

retiredAtstring (date-time)

When the rule was retired. Absent for one that is not.

Example 2026-08-19T04:21:07Z

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

createdBystringrequired

Who made the policy, keyed as a person or an API key is: user_ or staff_ or key_, and an id.

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedBystringrequired

Who made the current version.

approvedBystring

approvedAtstring (date-time)

Example 2026-08-19T04:21:07Z

rejectedBystring

rejectedAtstring (date-time)

Example 2026-08-19T04:21:07Z

Example

{
  "type": "RpolUpdateRspAttributes",
  "updated": {
    "type": "RpolViewAttributes",
    "rulePolicyId": "rpol_9f2Kd8QpLzXw",
    "domain": "string",
    "owner": {
      "type": "RpolOwnerEnterprise",
      "enterpriseId": "ent_9f2Kd8QpLzXw"
    },
    "state": "Draft",
    "mode": "Shadow",
    "paused": true,
    "rule": {
      "type": "RpolRuleAttributes",
      "templateId": "string",
      "arguments": [
        {
          "type": "RpolArgumentAttributes",
          "parameterId": "string",
          "value": {
            "type": "RpolValueAmount",
            "amount": {
              "type": "IsoCurrencyAmount",
              "minorCurrencyUnits": 1250,
              "currency": "AUD"
            }
          }
        }
      ],
      "action": {
        "type": "RpolActionAttributes",
        "name": "Ada Lovelace"
      }
    },
    "templateVersion": 1250,
    "description": "string",
    "version": 1250,
    "effectiveFrom": "2026-08-19T04:21:07Z",
    "effectiveUntil": "2026-08-19T04:21:07Z",
    "retiredAt": "2026-08-19T04:21:07Z",
    "createdAt": "2026-08-19T04:21:07Z",
    "createdBy": "string",
    "updatedAt": "2026-08-19T04:21:07Z",
    "updatedBy": "string",
    "approvedBy": "string",
    "approvedAt": "2026-08-19T04:21:07Z",
    "rejectedBy": "string",
    "rejectedAt": "2026-08-19T04:21:07Z"
  }
}

Error responses

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}