Ctrl+K

Consolidate whitelist policy rules

put/api/v2/admin/policy/{policyUniqueId}/consolidateCoinAddressWhitelists

Replace all coinAddressWhitelist rules for a policy with a single rule which whitelists a set of addresses for all coins. This is done for the purpose of migrating legacy ERC20 policies that had a separate rule for each token.

Path Parameters

  • policyUniqueIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Request Body

addresses array[string] required
Recipient addresses for the new rule. All addresses must already be present in the policy.
Min items: >= 1 items
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
mutabilityConstraint string
Specifies whether a BitGo admin can change `lockDate` * `managed` - Not locked, but requires approval from a BitGo admin to change * `permanent` - `lockDate` cannot be changed
Allowed values: managed permanent

200 Response

id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
date string <date-time>
label string
latest boolean required
rules array[object] required
id string required
lockDate string <date-time>required
The time at which this rule becomes immutable
mutabilityConstraint string
Specifies whether a BitGo admin can change `lockDate` * `managed` - Not locked, but requires approval from a BitGo admin to change * `permanent` - `lockDate` cannot be changed
Allowed values: managed permanent
coin string
A cryptocurrency or token ticker symbol.
Example: btc
type string required
What causes this rule to trigger
Allowed values: advancedWhitelist allTx bitcoinAddressWhitelist coinAddressWhitelist coinAddressBlacklist transactionLimit velocityLimit webhook
conditionOne of
Parameters for the type
action object required
What happens when this rule is triggered
version integer required
enterpriseId string
The Enterprise to which this Policy applies
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
walletId string
The Wallet to which this Policy applies
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$