GRgreendot
AMMRule

Update an existing AMM rule

Updates the details of an existing Auto Money Movement (AMM) rule for the specified account and rule ID.

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

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

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

ruleIDinteger required

The unique identifier for the AMM rule to update.

ammRuleNamestring nullable

The name assigned to the AMM rule.

startDatestring date-time

The start date when the rule becomes active.

endDatestring date-time

The end date when the rule expires or is deactivated.

maxCapAmountnumber double

The maximum cap amount for transfers under this rule.

rulePriorityinteger

The priority of the rule for execution order.

fixedTransferAmountnumber double

The fixed transfer amount for each execution of the rule.

transferPercentagenumber double

The percentage of the qualifying amount to transfer.

scheduleDayinteger

The scheduled day for rule execution (e.g., day of month).

ruleFrequencystring nullable

The frequency type of the rule (e.g., "Daily", "Weekly", "Monthly").

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.