Documentation | Policies › Delete Policy

Policies

policies

Methods

Create Policy ->

Policy

post/v1/policies

Create a new policy.

Get Policy ->

Policy

get/v1/policies/{policy_id}

Get a policy by policy ID.

Get Policy Rule -> { id, action, conditions, 2 more... }

get/v1/policies/{policy_id}/rules/{rule_id}

Get a rule by policy ID and rule ID.

Update Policy ->

Policy

patch/v1/policies/{policy_id}

Update a policy by policy ID.

Delete Policy -> { success }

delete/v1/policies/{policy_id}

Delete a policy by policy ID.

path Parameters

policy_id: string

(minLength: 24, maxLength: 24)

header Parameters

privy-authorization-signature: string

Optional

Request authorization signature. If multiple signatures are required, they should be comma separated.

Response fields

success: boolean

Whether the policy was deleted successfully.

Request example

curl https://api.privy.io/v1/policies/$POLICY_ID \
    -X DELETE \
    -u "$PRIVY_APP_ID:PRIVY_APP_SECRET"

200Example

{
  "success": true
}

Create Policy Rule -> { id, action, conditions, 2 more... }

post/v1/policies/{policy_id}/rules

Create a new rule for a policy.

Update Policy Rule -> { id, action, conditions, 2 more... }

patch/v1/policies/{policy_id}/rules/{rule_id}

Update a rule by policy ID and rule ID.

Delete Policy Rule -> { success }

delete/v1/policies/{policy_id}/rules/{rule_id}

Delete a rule by policy ID and rule ID.

Domain types

Policy = { id, chain_type, created_at, 4 more... }

A policy for controlling wallet operations.

SuiTransactionCommandCondition = { field, field_source, operator, 1 more... }

SUI transaction command attributes, enables allowlisting specific command types. Allowed commands: 'TransferObjects', 'SplitCoins', 'MergeCoins'. Only 'eq' and 'in' operators are supported.

SuiTransactionCommandOperator = "eq" | "in"

Operator to use for SUI transaction command conditions. Only 'eq' and 'in' are supported for command names.

SuiTransferObjectsCommandCondition = { field, field_source, operator, 1 more... }

SUI TransferObjects command attributes, including recipient and amount fields.

SuiTransferObjectsCommandField = "recipient" | "amount"

Supported fields for SUI TransferObjects command conditions. Only 'recipient' and 'amount' are supported.

TronTransactionCondition = { field, field_source, operator, 1 more... }

TRON transaction fields for TransferContract and TriggerSmartContract transaction types.