---
title: "Update the status of an AMM rule"
method: PUT
path: "/programs/{programCode}/accounts/{accountIdentifier}/ammRuleStatus/{ruleId}"
tags: ["AMMRule"]
---

# Update the status of an AMM rule

`PUT /programs/{programCode}/accounts/{accountIdentifier}/ammRuleStatus/{ruleId}`

Updates the status, name, maximum cap amount, or fixed transfer amount for a specific Auto Money Movement (AMM) rule based on rule ID.

## Path parameters

- `programCode` string, required
- `accountIdentifier` string, required
- `ruleId` integer, required

## Headers

- `X-GD-RequestId` string, required

## Request body

- UpdateAMMRuleStatusRequest — Represents a request to update the status of an Automated Money Movement (AMM) rule. Contains the source account identifier, rule ID, new status, and optional end date. Inherits standard request metadata from Gd.Bos.DataTransfer.Request.RequestBase.
  - `ruleStatus` 'active' | 'inactive' | 'expiring' | 'completed' | 'paused', nullable — The new status to set for the AMM rule (e.g., Active, Inactive, Expiring, Completed, Paused). Uses Gd.Bos.DataTransfer.Enums.AMMRuleStatus to specify the rule status.
  - `endDate` string, date-time, nullable — The end date for the AMM rule, if applicable. Used when expiring or completing a rule.

## Response `200`

OK

- UpdateAMMRuleStatusResponse — Represents the response returned after updating the status of an Automated Money Movement (AMM) rule. Used to indicate the outcome of an AMM rule status update operation. Inherits standard response metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/versions/666553766b78/schema)