Archive Policy

DELETE /v2/policies/{policyId}

Archives a policy.

Required Permissions

NameConditions

Policies:Archive

Always Required

Parameters

Path parameters

Path parameterDescription

policyId

Unique identifier of the policy

Response

Response example 200 - no approval required

{
  "id": "plc-...",
  "name": "Transfer Limit",
  "rule":{
    "kind": "TransactionAmountLimit",
    "configuration": {
      "currency": "EUR",
      "limit": "1000"
    }
  },
  "status": "Archived",
  "filters": {
    "id": {
      "in": [
        "wa-..."
      ]
    }
  },
  "activityKind": "Wallets:Sign",
  "action":{
    "kind": "RequireApproval",
    "approvalGroups": [
      {
        "name": "Admins",
        "quorum": 1,
        "approvers": {
          "userId": {
            "in": [
              "us-..."
            ]
          }
        }
      }
    ],
    "autoRejectTimeout": 60
  }
}

Response example 202 - approval required

{
  "id": "cr-...",
  "orgId": "or-...",
  "requester": {
    "appId": "ap-...",
    "userId": "us-...",
    "tokenId": "to-..."
  },
  "kind": "Policy",
  "operationKind": "Update",
  "status": "Pending",
  "entityId": "plc-...",
  "body": {
    "id": "plc-...",
    "name": "Transfer Limit",
    "rule": {
      "kind": "TransactionAmountLimit",
      "configuration": {
        "currency": "EUR",
        "limit": "1000"
      }
    },
    "status": "Archived",
    "filters": {
      "id": {
        "in": [
          "wa-..."
        ]
      }
    },
    "activityKind": "Wallets:Sign",
    "action": {
      "kind": "RequestApproval",
      "approvalGroups": [
        {
          "name": "Admins",
          "quorum": 1,
          "approvers": {
            "userId": {
              "in": [
                "us-..."
              ]
            }
          }
        }
      ],
      "autoRejectTimeout": 60
    }
  },
  "dateCreated": "2023-12-22T20:57:55.814Z",
  "dateResolved": "2023-12-22T20:57:55.814Z"
}

Last updated