Documentation | Intents › Create Policy Rule Delete Intent

Intents

intents

Methods

List Intents -> Cursor<

IntentResponse

get/v1/intents

List intents for an app. Returns a paginated list of intents with their current status and details.

Get Intent ->

IntentResponse

get/v1/intents/{intent_id}

Retrieve an intent by ID. Returns the intent details including its current status, authorization details, and execution result if applicable.

Create Rpc Intent ->

RpcIntentResponse

post/v1/intents/wallets/{wallet_id}/rpc

Create an intent to execute an RPC method on a wallet. The intent must be authorized by either the wallet owner or signers before it can be executed.

Create Transfer Intent ->

TransferIntentResponse

post/v1/intents/wallets/{wallet_id}/transfer

Create an intent to execute a token transfer via a wallet. The intent must be authorized by either the wallet owner or signers before it can be executed.

Create Wallet Update Intent ->

WalletIntentResponse

patch/v1/intents/wallets/{wallet_id}

Create an intent to update a wallet. The intent must be authorized by the wallet owner before it can be executed.

Create Policy Update Intent ->

PolicyIntentResponse

patch/v1/intents/policies/{policy_id}

Create an intent to update a policy. The intent must be authorized by the policy owner before it can be executed.

Create Policy Rule Intent ->

RuleMutateIntentResponse

post/v1/intents/policies/{policy_id}/rules

Create an intent to add a rule to a policy. The intent must be authorized by the policy owner before it can be executed.

Create Policy Rule Update Intent ->

RuleMutateIntentResponse

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

Create an intent to update a rule on a policy. The intent must be authorized by the policy owner before it can be executed.

Create Policy Rule Delete Intent ->

RuleDeleteIntentResponse

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

Create an intent to delete a rule from a policy. The intent must be authorized by the policy owner before it can be executed.

path Parameters

policy_id: string

ID of the policy.

rule_id: string

ID of the rule.

header Parameters

privy-request-expiry: string

Optional

Request expiry. Value is a Unix timestamp in milliseconds representing the deadline by which the request must be processed.

Response fields

RuleDeleteIntentResponse

Request example

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

200Example

{
  "authorization_details": [
    {
      "members": [
        {
          "signed_at": 0,
          "type": "user",
          "user_id": "user_id"
        }
      ],
      "threshold": 0,
      "display_name": "display_name"
    }
  ],
  "created_at": 0,
  "created_by_display_name": "created_by_display_name",
  "custom_expiry": true,
  "expires_at": 0,
  "intent_id": "intent_id",
  "resource_id": "resource_id",
  "status": "pending",
  "created_by_id": "created_by_id",
  "dismissal_reason": "dismissal_reason",
  "dismissed_at": 0,
  "rejected_at": 0,
  "intent_type": "RULE",
  "request_details": {
    "method": "DELETE",
    "url": "http://localhost:16699/v1/policies/0vrb2zhnb0xh1j06x1i4ecdd3/rules/ow6nzp23y38d03ad25aac6s28",
    "body": {}
  },
  "action_result": {
    "executed_at": 0,
    "status_code": 0,
    "authorized_by_display_name": "authorized_by_display_name",
    "authorized_by_id": "authorized_by_id"
  },
  "current_resource_data": {
    "id": "rule_123",
    "action": "ALLOW",
    "conditions": [
      {
        "field": "to",
        "field_source": "ethereum_transaction",
        "operator": "eq",
        "value": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
      }
    ],
    "method": "eth_sendTransaction",
    "name": "Allowlist USDC contract on Base"
  },
  "policy": {
    "id": "tb54eps4z44ed0jepousxi4n",
    "chain_type": "ethereum",
    "created_at": 1741833088894,
    "name": "Allowlisted stablecoins",
    "owner_id": null,
    "rules": [
      {
        "id": "bdyfoa65pro1eez6iwtzanol",
        "action": "ALLOW",
        "conditions": [
          {
            "field": "to",
            "field_source": "ethereum_transaction",
            "operator": "eq",
            "value": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
          }
        ],
        "method": "eth_sendTransaction",
        "name": "Allowlist USDC contract on Base"
      }
    ],
    "version": "1.0"
  }
}

Create Key Quorum Update Intent ->

KeyQuorumIntentResponse

patch/v1/intents/key_quorums/{key_quorum_id}

Create an intent to update a key quorum. The intent must be authorized by the key quorum members before it can be executed.

Domain types

BaseActionResult = { executed_at, status_code, authorized_by_display_name, 1 more... }

Common fields for intent action execution results.

BaseIntentResponse = { authorization_details, created_at, created_by_display_name, 9 more... }

Common fields shared by all intent response types.

IntentAuthorization = { members, threshold, display_name }

Authorization quorum for an intent

IntentAuthorizationKeyQuorumMember = { signed_at, type, user_id } | { public_key, signed_at, type }

A leaf member (user or key) of a nested key quorum in an intent authorization.

IntentAuthorizationMember = { signed_at, type, user_id } | { public_key, signed_at, type } | { key_quorum_id, members, threshold, 3 more... }

A member of an intent authorization quorum. Can be a user, key, or nested key quorum.

IntentAuthorizeInput = { signature, timestamp }

Request body for authorizing an intent.

IntentCreationHeaders = { privy-app-id, privy-request-expiry }

Headers required to create an intent.

IntentResponse =

RpcIntentResponse

TransferIntentResponse

WalletIntentResponse

| 3 more...

Response for an intent object

IntentStatus = "pending" | "processing" | "executed" | 4 more...

Current status of an intent.

IntentType = "KEY_QUORUM" | "POLICY" | "RULE" | 3 more...

Type of intent.

KeyQuorumIntentResponse =

BaseIntentResponse

Response for a key quorum intent

PolicyIntentRequestDetails = { body, method, url }

Request details for a policy intent.

PolicyIntentResponse =

BaseIntentResponse

Response for a policy intent

RpcIntentRequestDetails = { body, method, url }

Request details for an RPC intent.

RpcIntentResponse =

BaseIntentResponse

Response for an RPC intent

RuleDeleteIntentResponse =

BaseIntentResponse

Response for a delete rule intent

RuleIntentCreateRequestDetails = { body, method, url }

Request details for creating a rule via intent.

RuleIntentDeleteRequestDetails = { method, url, body }

Request details for deleting a rule via intent.

RuleIntentRequestDetails =

RuleIntentCreateRequestDetails

RuleIntentUpdateRequestDetails

RuleIntentDeleteRequestDetails

The original rule request. Method is POST (create), PATCH (update), or DELETE (delete)

RuleIntentResponse =

BaseIntentResponse

Response for a rule intent

RuleIntentUpdateRequestDetails = { body, method, url }

Request details for updating a rule via intent.

RuleMutateIntentResponse =

BaseIntentResponse

Response for a create or update rule intent

TransferIntentRequestDetails = { body, method, url }

Request details for a transfer intent.

TransferIntentResponse =

BaseIntentResponse

Response for a transfer intent

WalletIntentResponse =

BaseIntentResponse

Response for a wallet intent