Update the status of an AMM rule

put

https://example.com/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 Params

programCode

string

required

The program code identifying the BaaS program context.

accountIdentifier

string

required

The unique identifier for the account associated with the rule.

ruleId

int64

required

The unique identifier for the rule to update.

Body Params

The request payload containing the rule ID and new status.

ruleStatus

string | null

enum

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.

Allowed:

endDate

date-time | null

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

Headers

X-GD-RequestId

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

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

text/json

200OK

403Forbidden

500Internal Server Error

503Service Unavailable