API Reference

Update an existing AMM rule

put
https://example.com/programs//accounts//ammRule/

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

Path Params
string
required

The program code identifying the BaaS program context.

string
required

The unique identifier for the account associated with the rule.

int64
required

The unique identifier for the rule to update.

Body Params

The request payload containing updated AMM rule details.

int64
required

The unique identifier for the AMM rule to update.

string | null

The name assigned to the AMM rule.

date-time

The start date when the rule becomes active.

date-time

The end date when the rule expires or is deactivated.

double

The maximum cap amount for transfers under this rule.

int32

The priority of the rule for execution order.

double

The fixed transfer amount for each execution of the rule.

double

The percentage of the qualifying amount to transfer.

int32

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

string | null

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

Headers
string
required

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

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago