PUT

Update policy rule

Updates a policy rule, resulting in a new version number that's equal to the highest existing version plus 1. The ID of the policy rule remains the unchanged.

Path Params

enterpriseId string required

Your Enterprise Id.
touchpointName string required

The name of the Touchpoint.
id string required

Id of the policy rule.

Body Params

object

Create or Update policy rule Request.

name string required

Human readable name of the rule.

up to 256 characters
adminOnly boolean

true, if the policy rule is a BitGo internal rule, false otherwise.
clauses array of objects required

List of policy rule Clauses: a combination of Conditions and Actions.
clauses object
- conditions array of objects required
  ANY OF
  name string enum required
  
  Name of the condition.
  
  transfer.amount
  
  parameters object required
  
  Data required to evaluate the condition.
  
  parameters object
  
  operator string enum required
  
  The comparison operator to use when comparing the transfer amount with the given limit
  
  >>=<<=
  
  amount string required
  
  The transfer amount is compared with this limit.
  
  coin string required
  
  This condition only applies to transfers of this currency (USD applies to all transfers).
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the condition.
  
  transfer.velocity.limit
  
  parameters object required
  
  Data required to evaluate the transfer velocity limit condition.
  
  parameters object
  
  scope string enum required
  
  Entities to include in the velocity calculation.
  
  walletenterprise
  
  timeWindow string required
  
  A window of time in which a set of amount can be spent.
  
  amount string required
  
  The transfer amount is compared with this limit.
  
  coin string required
  
  The unit that the amount is denoted in, in either crypto or a fiat currency.
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the condition.
  
  transfer.destination.type
  
  parameters object required
  
  Data required to evaluate the transfer destination condition.
  
  parameters object
  
  type string enum required
  
  The type of destination this condition will match.
  
  whitelistedAddressnonWhitelistedAddressoutsideEnterprise
  
  coin string
  
  The asset this condition applies to.
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the condition.
  
  transfer.initiators
  
  parameters object required
  
  Data required to evaluate the transfer initiator condition.
  
  parameters object
  
  userIds array of strings required
  
  A list of user IDs to validate for the transfer initiator.
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the condition.
  
  transfer.webhook
  
  parameters object required
  
  Data required to evaluate the transfer webhook condition.
  
  parameters object
  
  webhookUrl string required
  
  The webhook url to post transfer payload to.
  
  coin string
  
  The asset this condition applies to.
  name string enum required
  
  Name of the associated Condition.
  
  transfer.notInitiatedBy
  
  parameters object required
  
  Required data needed to evaluate the Condition.
  
  parameters object
  
  userIds array of strings required
  
  List of user IDs
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
- actions array of objects required
  ANY OF
  name string enum required
  
  Name of the associated Action.
  
  approvals.always.deny
  name string enum required
  
  Name of the associated Action.
  
  approvals.customer.walletAdmin
  
  parameters object required
  
  Required data needed to configure the Action.
  
  parameters object
  
  minRequired string required
  
  Number of required approvals
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the associated Action.
  
  approvals.customer.finalApproval
  
  parameters object required
  
  Required data needed to configure the Action.
  
  parameters object
  
  userIds array of strings required
  
  The final approvers
  
  initiatorIsAllowedToApprove boolean
  
  Whether the initiator is allowed to approve this action. true by default.
  
  Defaults to true
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the associated Action.
  
  approvals.customer.enterpriseUser
  
  parameters object required
  
  Required data needed to configure the Action.
  
  parameters object
  
  userIds array of strings required
  
  List of enterprise users for approval
  
  minRequired number required
  
  Minimum required number of approvers
  
  initiatorIsAllowedToApprove boolean
  
  Whether the initiator is allowed to approve this action. false by default.
  
  Defaults to false
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the associated Action.
  
  approvals.customer.enterpriseAdmin
  
  parameters object required
  
  Required data needed to configure the Action.
  
  parameters object
  
  minRequired number required
  
  Minimum required number of approvers
  
  initiatorIsAllowedToApprove boolean
  
  Whether the initiator is allowed to approve this action. false by default.
  
  Defaults to false
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the associated Action.
  
  approvals.bitgo.livenessVerificationFromEnterpriseAdmins
  
  parameters object required
  
  Required data needed to configure the Action.
  
  parameters object
  
  minRequired number required
  
  Minimum required number of approvers
  
  initiatorIsAllowedToApprove boolean
  
  Whether the initiator is allowed to approve this action. false by default.
  
  Defaults to false
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the associated Action.
  
  approvals.bitgo.livenessVerificationFromRequestor
  
  parameters object
  
  Required data needed to configure the Action.
  
  parameters object
  
  minRequired number
  
  Minimum required number of approvers
  
  initiatorIsAllowedToApprove boolean
  
  Whether the initiator is allowed to approve this action. false by default.
  
  Defaults to false
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the associated Action.
  
  approvals.bitgo.livenessVerificationFromUsers
  
  parameters object required
  
  Required data needed to configure the Action.
  
  parameters object
  
  userIds array of strings required
  
  List of enterprise users for approval
  
  minRequired number required
  
  Minimum required number of approvers
  
  initiatorIsAllowedToApprove boolean
  
  Whether the initiator is allowed to approve this action. false by default.
  
  Defaults to false
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the associated Action.
  
  approvals.bitgo.noop
  
  parameters map
  
  Required data needed to configure the Action.
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the associated Action.
  
  approvals.bitgo.videoApproval
  
  parameters object required
  
  Required data needed to configure the Action.
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the associated Action.
  
  approvals.bitgo.idVerification
  
  parameters object required
  
  Required data needed to configure the Action.
  
  parameters object
  
  isFallback boolean
  
  Whether this is a fallback action.
  
  Defaults to false
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the associated Action.
  
  approvals.customer.organizationAdmin
  
  parameters object required
  
  Required data needed to configure the Action.
  
  parameters object
  
  minRequired string required
  
  Minimum required number of approvers
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
filteringConditions array of objects required

List of Filtering Conditions that must trigger for the policy rule to be Evaluated.
ANY OF
- name string enum required
  
  Name of the condition.
  
  wallet.ids
- parameters object required
  
  Required data needed to evaluate the Filtering Condition.
  parameters object
  
  walletId array of strings required
- name string enum required
  
  Name of the condition.
  
  wallet.type
- parameters object required
  
  Required data needed to evaluate the Filtering Condition.
  parameters object
  
  walletType array of string enums required
  
  hotcustodialtrading
- name string enum required
  
  Name of the condition.
  
  wallet.all
- name string enum required
  
  Name of the condition.
  
  rule.all
- parameters map
  
  Required data needed to evaluate the Filtering Condition.
- name string enum required
  
  Name of the condition.
  
  wallet.multiple.ids
- parameters object required
  
  Required data needed to evaluate the Filtering Condition.
  parameters object
  
  walletId array of strings required
lockType string enum
Indicates how the policy rule is locked.
- LOCK_AFTER_DATE - Will lock after the lockDate set on the policy rule.
- PERMANENT - Is permanently locked.
- NEVER - Is never locked.
LOCK_AFTER_DATEPERMANENTNEVER
lockDate string date-time

The date after which the policy rule will be locked. Only applicable if the policy rule is locked with LOCK_AFTER_DATE.

Responses

201

The updated policy rule

Response Body

object

A Policy Rule, the combination of a Scope, a Touchpoint, Conditions, and Actions. It allows you to define what needs to happen (Actions) before a user can execute a sensitive operation (Touchpoint) on a Scope (e.g. a Wallet) depending on the specific details of the operation (Conditions). See Concepts.

id string required

Id of the Policy Rule. This identifier is not unique in isolation, it must be paired with an specific Policy Rule Version number to uniquely identified a particular version of a Policy Rule. A UUID.
uniqueId string required

The uniqueId of the Policy Rule version. A UUID.
name string required

Human readable name of the rule.
status string enum required
Indicates if the Policy Rule is considered in Evaluations.
- ACTIVE - Will be Evaluated.
- INACTIVE - Will NOT be Evaluated.
- DENIED - The requested policy rule change was Denied.
- PENDING_APPROVAL - This version of the policy rule is Pending Approval before it can be activated.
- UNLOCK_PENDING - This version of the policy rule is created when a request to unlock a policy is initiated.
ACTIVEINACTIVEDENIEDPENDING_APPROVALUNLOCK_PENDING
version integer

The Policy Rule Version, an integer that is incremented each time the Policy Rule changes.

Defaults to 1
adminOnly boolean required

true, if the Policy Rule is a BitGo internal rule. Typically, this allows setting Global Policy Rules across enterprises.
touchpointId string required

The id of the Touchpoint associated with the Policy Rule. A UUID.
touchpointLabel string required

Label of the Touchpoint associated with the Policy Rule. For example the Transfer from a Wallet Touchpoint.
scopeId string required

The id of the Scope associated with the Policy Rule. A UUID.
scopeLabel string required

Label of the Scope associated with the Policy Rule. For example the All Wallets Scope.
clauses array of objects required

List of Policy Rule Clauses: a combination of Conditions and Actions.
clauses object
- actions array of objects
  ANY OF
  name string enum required
  
  Name of the associated Action.
  
  approvals.always.deny
  name string enum required
  
  Name of the associated Action.
  
  approvals.customer.enterpriseAdmin
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the associated Action.
  
  approvals.customer.walletAdmin
  
  parameters object required
  
  Required data needed to configure the Action.
  
  parameters object
  
  minRequired string required
  
  Number of required approvals
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the associated Action.
  
  approvals.customer.finalApproval
  
  parameters object required
  
  Required data needed to configure the Action.
  
  parameters object
  
  userIds array of strings required
  
  The final approvers
  
  initiatorIsAllowedToApprove boolean
  
  Whether the initiator is allowed to approve this action. true by default.
  
  Defaults to true
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the associated Action.
  
  approvals.customer.enterpriseUser
  
  parameters object required
  
  Required data needed to configure the Action.
  
  parameters object
  
  userIds array of strings required
  
  List of enterprise users for approval
  
  minRequired number required
  
  Minimum required number of approvers
  
  initiatorIsAllowedToApprove boolean
  
  Whether the initiator is allowed to approve this action. false by default.
  
  Defaults to false
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
- conditions array of objects
  ANY OF
  name string enum required
  
  Name of the condition.
  
  transfer.amount
  
  parameters object required
  
  Data required to evaluate the condition.
  
  parameters object
  
  operator string enum required
  
  The comparison operator to use when comparing the transfer amount with the given limit
  
  >>=<<=
  
  amount string required
  
  The transfer amount is compared with this limit.
  
  coin string required
  
  This condition only applies to transfers of this currency (USD applies to all transfers).
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the condition.
  
  transfer.velocity.limit
  
  parameters object required
  
  Data required to evaluate the transfer velocity limit condition.
  
  parameters object
  
  scope string enum required
  
  Entities to include in the velocity calculation.
  
  walletenterprise
  
  timeWindow string required
  
  A window of time in which a set of amount can be spent.
  
  amount string required
  
  The transfer amount is compared with this limit.
  
  coin string required
  
  The unit that the amount is denoted in, in either crypto or a fiat currency.
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the condition.
  
  transfer.destination.type
  
  parameters object required
  
  Data required to evaluate the transfer destination condition.
  
  parameters object
  
  type string enum required
  
  The type of destination this condition will match.
  
  whitelistedAddressnonWhitelistedAddressoutsideEnterprise
  
  coin string
  
  The asset this condition applies to.
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
  name string enum required
  
  Name of the condition.
  
  transfer.initiators
  
  parameters object required
  
  Data required to evaluate the transfer initiator condition.
  
  parameters object
  
  userIds array of strings required
  
  A list of user IDs to validate for the transfer initiator.
  
  operator string enum
  
  Boolean operators that join Conditions, and/or Actions. Must be null on the last Condition or Action, or if there is only one Condition or Action, must be non-null on all others.
  
  ANDOR
filteringConditions array of objects required

List of Filtering Conditions that must trigger for this Policy Rule to be Evaluated.
ANY OF
- name string enum required
  
  Name of the condition.
  
  wallet.type
- parameters object required
  
  Required data needed to evaluate the Filtering Condition.
  parameters object
  
  walletType array of string enums required
  
  hotcustodialtrading
- name string enum required
  
  Name of the condition.
  
  wallet.ids
- parameters object required
  
  Required data needed to evaluate the Filtering Condition.
  parameters object
  
  walletId array of strings required
- name string enum required
  
  Name of the condition.
  
  wallet.all
- name string enum required
  
  Name of the condition.
  
  rule.all
- parameters map
  
  Required data needed to evaluate the Filtering Condition.
- name string enum required
  
  Name of the condition.
  
  wallet.multiple.ids
- parameters object required
  
  Required data needed to evaluate the Filtering Condition.
  parameters object
  
  walletId array of strings required
locked boolean required

true, if the Policy Rule is locked, false otherwise.
lockType string enum required
Indicates how the Policy Rule is locked.
- LOCK_AFTER_DATE - Will lock after the lockDate set on the Policy Rule.
- PERMANENT - Is permanently locked.
LOCK_AFTER_DATEPERMANENT
lockDate string date-time

The date after which the Policy Rule will be locked. Only applicable if the Policy Rule is locked with LOCK_AFTER_DATE.
enterpriseId string

The id of the Enterprise this Policy Rule belongs to.
organizationId string

The id of the Organization this Policy Rule belongs to.
lastTriggeredDate string date-time

The date when the Policy Rule was last triggered. Only applicable if the Policy Rule is locked with LOCK_AFTER_DATE.
lastTriggeredEvaluationId string

The id of the Evaluation that last triggered the Policy Rule. A UUID.
createdBy string required

The id of the user who created the Policy Rule or the string "BitGo".
modifiedBy string required

The id of the user who last modified the Policy Rule or the string "BitGo".
createdDate string date-time required

The date when the Policy Rule was created. A timestamp.
modifiedDate string date-time required

The date when the Policy Rule was last modified. A timestamp.
lockModifiedBy string

The id of the user who last modified the lock of the Policy Rule.
evaluationId string

The id of the Evaluation that was done when this Policy Rule version was requested to be created, modified or deleted. A UUID.

400

Bad Request

Response Body

ONE OF

code string
message string
status integer

code string
message string
status integer
failedValidations object

401

Unauthorized

Response Body

object

code string
message string
status integer

403

Forbidden

Response Body

object

code string
message string
status integer

404

The specified resource was not found

Response Body

object

code string
message string
status integer

409

Conflict - The request conflicts with the current state of the resource

Response Body

object

code string
message string
status integer

500

Server Error - Transient error please try again

Response Body

object

code string
message string
status integer

Language

Credentials

Bearer

Request

curl --request PUT \
     --url 'https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointName/rules/id' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
     --header 'content-type: application/json' \
     --data '{,"name":"Get approval if transferring more than 2 BTC in a minute","adminOnly":false,"clauses":[{,"conditions":[{,"name":"transfer.velocity.limit","parameters":{,"operator":">","amount":"2000000","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"scope":"wallet","timeWindow":"60","amount":"2000000","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"type":"whitelistedAddress","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"userIds":["string"]},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"webhookUrl":"https://webhook.site/91561f7b-4141-4ee2-8336-e10650cd000f","coin":"btc"}}{,"name":"transfer.velocity.limit","parameters":{,"userIds":["6941488084accb8c933550111d2661cb"]},"operator":"AND"}],"actions":[{,"name":"approvals.customer.walletAdmin"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":"1"},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"initiatorIsAllowedToApprove":true},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"isFallback":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":"1"},"operator":"AND"}]}],"filteringConditions":[{,"name":"wallet.ids","parameters":{,"walletId":["643f146bb13653000765c478a384a656"]}}{,"name":"wallet.ids","parameters":{,"walletType":["hot"]}}{,"name":"wallet.ids"}{,"name":"wallet.ids","parameters":{"walletId":["643f146bb13653000765c478a384a656"]}}{,"name":"wallet.ids","parameters":{,"walletId":["643f146bb13653000765c478a384a656"]}}],"lockType":"LOCK_AFTER_DATE","lockDate":"2023-11-13T14:49:48.830522Z"}'

Request

const url = 'https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointName/rules/id';
const options = {
  method: 'PUT',
  headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'},
  body: JSON.stringify({,"name":"Get approval if transferring more than 2 BTC in a minute","adminOnly":false,"clauses":[{,"conditions":[{,"name":"transfer.velocity.limit","parameters":{,"operator":">","amount":"2000000","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"scope":"wallet","timeWindow":"60","amount":"2000000","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"type":"whitelistedAddress","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"userIds":["string"]},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"webhookUrl":"https://webhook.site/91561f7b-4141-4ee2-8336-e10650cd000f","coin":"btc"}}{,"name":"transfer.velocity.limit","parameters":{,"userIds":["6941488084accb8c933550111d2661cb"]},"operator":"AND"}],"actions":[{,"name":"approvals.customer.walletAdmin"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":"1"},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"initiatorIsAllowedToApprove":true},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"isFallback":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":"1"},"operator":"AND"}]}],"filteringConditions":[{,"name":"wallet.ids","parameters":{,"walletId":["643f146bb13653000765c478a384a656"]}}{,"name":"wallet.ids","parameters":{,"walletType":["hot"]}}{,"name":"wallet.ids"}{,"name":"wallet.ids","parameters":{"walletId":["643f146bb13653000765c478a384a656"]}}{,"name":"wallet.ids","parameters":{,"walletId":["643f146bb13653000765c478a384a656"]}}],"lockType":"LOCK_AFTER_DATE","lockDate":"2023-11-13T14:49:48.830522Z"})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Request

require 'uri'
require 'net/http'

url = URI("https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointName/rules/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["accept"] = 'application/json'
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'
request["content-type"] = 'application/json'
request.body = '{,"name":"Get approval if transferring more than 2 BTC in a minute","adminOnly":false,"clauses":[{,"conditions":[{,"name":"transfer.velocity.limit","parameters":{,"operator":">","amount":"2000000","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"scope":"wallet","timeWindow":"60","amount":"2000000","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"type":"whitelistedAddress","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"userIds":["string"]},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"webhookUrl":"https://webhook.site/91561f7b-4141-4ee2-8336-e10650cd000f","coin":"btc"}}{,"name":"transfer.velocity.limit","parameters":{,"userIds":["6941488084accb8c933550111d2661cb"]},"operator":"AND"}],"actions":[{,"name":"approvals.customer.walletAdmin"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":"1"},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"initiatorIsAllowedToApprove":true},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"isFallback":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":"1"},"operator":"AND"}]}],"filteringConditions":[{,"name":"wallet.ids","parameters":{,"walletId":["643f146bb13653000765c478a384a656"]}}{,"name":"wallet.ids","parameters":{,"walletType":["hot"]}}{,"name":"wallet.ids"}{,"name":"wallet.ids","parameters":{"walletId":["643f146bb13653000765c478a384a656"]}}{,"name":"wallet.ids","parameters":{,"walletId":["643f146bb13653000765c478a384a656"]}}],"lockType":"LOCK_AFTER_DATE","lockDate":"2023-11-13T14:49:48.830522Z"}'

response = http.request(request)
puts response.read_body

Request

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointName/rules/id', [
  'headers' => [
    'accept' => 'application/json',
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
    'content-type' => 'application/json',
  ],
  'body' => '{,"name":"Get approval if transferring more than 2 BTC in a minute","adminOnly":false,"clauses":[{,"conditions":[{,"name":"transfer.velocity.limit","parameters":{,"operator":">","amount":"2000000","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"scope":"wallet","timeWindow":"60","amount":"2000000","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"type":"whitelistedAddress","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"userIds":["string"]},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"webhookUrl":"https://webhook.site/91561f7b-4141-4ee2-8336-e10650cd000f","coin":"btc"}}{,"name":"transfer.velocity.limit","parameters":{,"userIds":["6941488084accb8c933550111d2661cb"]},"operator":"AND"}],"actions":[{,"name":"approvals.customer.walletAdmin"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":"1"},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"initiatorIsAllowedToApprove":true},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"isFallback":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":"1"},"operator":"AND"}]}],"filteringConditions":[{,"name":"wallet.ids","parameters":{,"walletId":["643f146bb13653000765c478a384a656"]}}{,"name":"wallet.ids","parameters":{,"walletType":["hot"]}}{,"name":"wallet.ids"}{,"name":"wallet.ids","parameters":{"walletId":["643f146bb13653000765c478a384a656"]}}{,"name":"wallet.ids","parameters":{,"walletId":["643f146bb13653000765c478a384a656"]}}],"lockType":"LOCK_AFTER_DATE","lockDate":"2023-11-13T14:49:48.830522Z"}',
]);

echo $response->getBody();

Request

import requests

url = "https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointName/rules/id"

payload = {,"name":"Get approval if transferring more than 2 BTC in a minute","adminOnly":false,"clauses":[{,"conditions":[{,"name":"transfer.velocity.limit","parameters":{,"operator":">","amount":"2000000","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"scope":"wallet","timeWindow":"60","amount":"2000000","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"type":"whitelistedAddress","coin":"btc"},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"userIds":["string"]},"operator":"AND"}{,"name":"transfer.velocity.limit","parameters":{,"webhookUrl":"https://webhook.site/91561f7b-4141-4ee2-8336-e10650cd000f","coin":"btc"}}{,"name":"transfer.velocity.limit","parameters":{,"userIds":["6941488084accb8c933550111d2661cb"]},"operator":"AND"}],"actions":[{,"name":"approvals.customer.walletAdmin"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":"1"},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"initiatorIsAllowedToApprove":true},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"userIds":["63cf101298470200073bbae71add80d5"],"minRequired":1,"initiatorIsAllowedToApprove":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"isFallback":false},"operator":"AND"}{,"name":"approvals.customer.walletAdmin","parameters":{,"minRequired":"1"},"operator":"AND"}]}],"filteringConditions":[{,"name":"wallet.ids","parameters":{,"walletId":["643f146bb13653000765c478a384a656"]}}{,"name":"wallet.ids","parameters":{,"walletType":["hot"]}}{,"name":"wallet.ids"}{,"name":"wallet.ids","parameters":{"walletId":["643f146bb13653000765c478a384a656"]}}{,"name":"wallet.ids","parameters":{,"walletId":["643f146bb13653000765c478a384a656"]}}],"lockType":"LOCK_AFTER_DATE","lockDate":"2023-11-13T14:49:48.830522Z"}
headers = {
    "accept": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

Response

{
  "adminOnly": false,
  "clauses": [
    {
      "actions": [
        {
          "name": "approvals.customer.walletAdmin",
          "parameters": {}
        }
      ],
      "conditions": [
        {
          "name": "transfer.velocity.limit",
          "parameters": {
            "amount": "2000000",
            "coin": "btc",
            "timeWindow": "60"
          }
        }
      ]
    }
  ],
  "createdBy": "5d1a5f2c8f0a9c001a5f2c8f0ad00000",
  "enterpriseId": "5d1a5f2c8f0a9c001a5f2c8f0ad00000",
  "evaluationId": "306258df-dcab-489e-a9fe-ff28ce9fa312",
  "filteringConditions": [
    {
      "name": "wallet.ids",
      "parameters": {
        "walletId": [
          "643f146bb13653000765c478a384a656"
        ]
      }
    }
  ],
  "id": "4fa8326b-4f5f-4065-8cfc-85a08c290c49",
  "lastTriggeredDate": "2023-11-13T14:49:48.830522Z",
  "lastTriggeredEvaluationId": "306258df-dcab-489e-a9fe-ff28ce9fa312",
  "lockType": "PERMANENT",
  "locked": true,
  "modifiedBy": "5d1a5f2c8f0a9c001a5f2c8f0ad00000",
  "name": "Get approval if transferring more than 2 BTC in a minute",
  "scopeLabel": "Wallet",
  "status": "ACTIVE",
  "touchpointLabel": "Transfer from a Segregated Wallet",
  "uniqueId": "c3ff569e-e30a-4405-8b76-38de240c724a",
  "version": 1
}

{
  "code": "BadRequest",
  "message": "Bad Request",
  "status": 400
}

{
  "code": "Unauthorized",
  "message": "Unauthorized",
  "status": 401
}

{
  "code": "AccessDenied",
  "message": "License not added for enterprise",
  "status": 403
}

{
  "code": "NotFound",
  "message": "Touchpoint not found",
  "status": 404
}

{
  "code": "Conflict",
  "message": "A pending change already exists for this policy rule",
  "status": 409
}

{
  "code": "Internal_Server_Error",
  "message": "Database is down",
  "status": 500
}