Add wallet-policy rule

post

https://app.bitgo-test.com/api/v2/{coin}/wallet/{walletId}/policy/rule

Adds a rule to a wallet’s policy. A wallet policy’s rules control the
conditions under which BitGo will use its single key to sign a
transaction. An email notification will be sent to all wallet users
when a policy is updated. This email is NOT sent for the first time
policy is added.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

coin

string

required

A cryptocurrency or token ticker symbol.

walletId

string

required

The wallet ID.

Body Params

coin

string

If set, the rule will only apply to the given coin or ERC20 token in an
Ethereum wallet. It is generally recommended to not set a coin for policy rules of the following types:
advancedWhitelist, allTx, coinAddressWhitelist, coinAddressBlacklist, webhook.

string

required

The id of the rule, must be unique among rules in the policy

type

string

enum

required

What causes this rule to trigger

Allowed:

condition

Advanced whitelist | Whitelist | Remove address from whitelist | object

Parameters for the type

action

object

required

What happens when this rule is triggered

lockDate

date-time

The time at which this rule becomes immutable

generatePolicy

boolean

When undefined or set to true, generates a policy enforcing the whitelist (if one has not been generated already) after the whitelist is created. If set to false, no policy will be generated.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

202Accepted

400Bad Request