Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
AMMRule

Update the status of an AMM rule

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

put/programs/{programCode}/accounts/{accountIdentifier}/ammRuleStatus/{ruleId}

Path parameters

programCodestring required

The program code identifying the BaaS program context.

accountIdentifierstring required

The unique identifier for the account associated with the rule.

ruleIdinteger required

The unique identifier for the rule to update.

Headers

X-GD-RequestIdstring required

A unique request identifier for tracking and logging. Should be a GUID.

Request body

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.

endDatestring date-time nullable

The end date for the AMM rule, if applicable. Used when expiring or completing a rule.

Response

OK