Skip to main content
PATCH
/
v1
/
intents
/
policies
/
{policy_id}
Create policy update intent
curl --request PATCH \
  --url https://api.privy.io/v1/intents/policies/{policy_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'privy-app-id: <privy-app-id>' \
  --data '
{
  "name": "<string>",
  "rules": [
    {
      "name": "<string>",
      "method": "eth_sendTransaction",
      "conditions": [
        {
          "field_source": "ethereum_transaction",
          "field": "to",
          "operator": "eq",
          "value": "<string>"
        }
      ],
      "action": "ALLOW"
    }
  ],
  "owner": {
    "user_id": "<string>"
  },
  "owner_id": "<string>"
}
'
{
  "intent_id": "<string>",
  "created_by_display_name": "<string>",
  "created_at": 123,
  "resource_id": "<string>",
  "authorization_details": [
    {
      "members": [
        {
          "type": "user",
          "user_id": "<string>",
          "signed_at": 123
        }
      ],
      "threshold": 123,
      "display_name": "<string>"
    }
  ],
  "status": "pending",
  "custom_expiry": true,
  "expires_at": 123,
  "intent_type": "POLICY",
  "request_details": {
    "method": "PATCH",
    "url": "<string>",
    "body": {
      "name": "<string>",
      "rules": [
        {
          "name": "<string>",
          "method": "eth_sendTransaction",
          "conditions": [
            {
              "field_source": "ethereum_transaction",
              "field": "to",
              "operator": "eq",
              "value": "<string>"
            }
          ],
          "action": "ALLOW"
        }
      ],
      "owner": {
        "user_id": "<string>"
      },
      "owner_id": "<string>"
    }
  },
  "created_by_id": "<string>",
  "rejected_at": 123,
  "dismissed_at": 123,
  "dismissal_reason": "<string>",
  "current_resource_data": {
    "id": "tb54eps4z44ed0jepousxi4n",
    "name": "Allowlisted stablecoins",
    "chain_type": "ethereum",
    "rules": [
      {
        "id": "bdyfoa65pro1eez6iwtzanol",
        "name": "Allowlist USDC contract on Base",
        "method": "eth_sendTransaction",
        "conditions": [
          {
            "field_source": "ethereum_transaction",
            "field": "to",
            "operator": "eq",
            "value": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
          }
        ],
        "action": "ALLOW"
      }
    ],
    "owner_id": null,
    "version": "1.0",
    "created_at": 1741833088894
  },
  "action_result": {
    "status_code": 123,
    "executed_at": 123,
    "response_body": {
      "id": "tb54eps4z44ed0jepousxi4n",
      "name": "Allowlisted stablecoins",
      "chain_type": "ethereum",
      "rules": [
        {
          "id": "bdyfoa65pro1eez6iwtzanol",
          "name": "Allowlist USDC contract on Base",
          "method": "eth_sendTransaction",
          "conditions": [
            {
              "field_source": "ethereum_transaction",
              "field": "to",
              "operator": "eq",
              "value": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
            }
          ],
          "action": "ALLOW"
        }
      ],
      "owner_id": null,
      "version": "1.0",
      "created_at": 1741833088894
    },
    "prior_state": {
      "id": "tb54eps4z44ed0jepousxi4n",
      "name": "Allowlisted stablecoins",
      "chain_type": "ethereum",
      "rules": [
        {
          "id": "bdyfoa65pro1eez6iwtzanol",
          "name": "Allowlist USDC contract on Base",
          "method": "eth_sendTransaction",
          "conditions": [
            {
              "field_source": "ethereum_transaction",
              "field": "to",
              "operator": "eq",
              "value": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
            }
          ],
          "action": "ALLOW"
        }
      ],
      "owner_id": null,
      "version": "1.0",
      "created_at": 1741833088894
    },
    "authorized_by_display_name": "<string>",
    "authorized_by_id": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.privy.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Basic Auth header with your app ID as the username and your app secret as the password.

Headers

​
privy-app-id
string
required

ID of your Privy app.

​
privy-request-expiry
string

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

Path Parameters

​
policy_id
string
required

ID of the policy.

Body

application/json
​
name
string

Name to assign to policy.

Required string length: 1 - 50
​
rules
PolicyRuleRequestBody · object[]
​
owner
OwnerInputUser · object

Owner input specifying a Privy user ID.

​
owner_id
string<cuid2> | null

The key quorum ID to set as the owner of the resource. If you provide this, do not specify an owner.

Response

200 - application/json

Created policy update intent.

Response for a policy intent

​
intent_id
string
required

Unique ID for the intent

​
created_by_display_name
string
required

Display name of the user who created the intent

​
created_at
number
required

Unix timestamp when the intent was created

​
resource_id
string
required

ID of the resource being modified (wallet_id, policy_id, etc)

​
authorization_details
IntentAuthorization · object[]
required

Detailed authorization information including key quorum members, thresholds, and signature status

​
status
enum<string>
required

Current status of an intent.

Available options:
pending,
executed,
failed,
expired,
rejected,
dismissed
​
custom_expiry
boolean
required

Whether this intent has a custom expiry time set by the client. If false, the intent expires after a default duration.

​
expires_at
number
required

Unix timestamp when the intent expires

​
intent_type
enum<string>
required
Available options:
POLICY
​
request_details
object
required

The original policy update request that would be sent to the policy endpoint

​
created_by_id
string

ID of the user who created the intent. If undefined, the intent was created using the app secret

​
rejected_at
number

Unix timestamp when the intent was rejected, present when status is 'rejected'

​
dismissed_at
number

Unix timestamp when the intent was dismissed, present when status is 'dismissed'

​
dismissal_reason
string

Human-readable reason for dismissal, present when status is 'dismissed'

​
current_resource_data
Policy · object

Current state of the policy before any changes. If undefined, the resource was deleted and no longer exists

Example:
{
  "id": "tb54eps4z44ed0jepousxi4n",
  "name": "Allowlisted stablecoins",
  "chain_type": "ethereum",
  "rules": [
    {
      "id": "bdyfoa65pro1eez6iwtzanol",
      "name": "Allowlist USDC contract on Base",
      "method": "eth_sendTransaction",
      "conditions": [
        {
          "field_source": "ethereum_transaction",
          "field": "to",
          "operator": "eq",
          "value": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
        }
      ],
      "action": "ALLOW"
    }
  ],
  "owner_id": null,
  "version": "1.0",
  "created_at": 1741833088894
}
​
action_result
BaseActionResult · object

Result of policy update execution (only present if status is 'executed' or 'failed')