API References

Update organization policy rule

put
https://app.bitgo-test.com/api/policy/v1/organizations//touchpoints//rules/

Updates an existing policy rule for an organization.

Authorization: Organization admins can update their organization's rules. BitGo admins have access to all organizations.

Requirements:

  • Cannot update if there is a pending change (PENDING_APPROVAL status) for the same rule
  • When the touchpoint has self_controlled=true, evaluation uses rules from that touchpoint instead of Policy Management
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The organization ID

string
required

The touchpoint name where the rule exists

uuid
required

The policy rule shared ID

Body Params
string
required
length ≤ 256

Human readable name of the rule.

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*
filteringConditions
array
required

List of Filtering Conditions that must trigger for the policy rule to be Evaluated.

filteringConditions*
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.
Allowed:
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

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago