Intents

Create policy rule update intent

Changed on

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

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

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/intents/policies/{policy_id}/rules/{rule_id}
  • Auth
    HTTP basic

Path parameters

policy_idstring required

ID of the policy.

rule_idstring required

ID of the rule.

Headers

privy-app-idstring required

ID of your Privy app.

privy-request-expirystring

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

Request body

namestring required
method'eth_sendTransaction' | 'eth_signTransaction' | 'eth_signUserOperation' | 'eth_signTypedData_v4' | 'personal_sign' | 'eth_sign7702Authorization' | 'wallet_sendCalls' | 'signTransaction' | 'signAndSendTransaction' | 'signMessage' | 'exportPrivateKey' | 'exportSeedPhrase' | 'signTransactionBytes' | 'signRawMessageBytes' | 'tron_sendTransaction' | 'tron_signTransaction' | 'xrpl_signTransaction' | 'earn_deposit' | 'earn_withdraw' | 'earn_incentive_claim' | 'transfer' | '*' required

Method the rule applies to.

action'ALLOW' | 'DENY' required

The action to take when a policy rule matches.

Example request

{
  "conditions": [
    {
      "field": "content"
    }
  ]
}

Response

Created rule update intent.

intent_idstring required

Unique ID for the intent

created_by_display_namestring required

Display name of the user who created the intent

created_by_idstring

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

created_atnumber required

Unix timestamp when the intent was created

resource_idstring required

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

status'pending' | 'processing' | 'executed' | 'failed' | 'expired' | 'rejected' | 'dismissed' required

Current status of an intent.

custom_expiryboolean required

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

expires_atnumber required

Unix timestamp when the intent expires

rejected_atnumber

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

dismissed_atnumber

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

dismissal_reasonstring

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

intent_type'RULE' required

Changes

  • 3a2288470053Revision changes
    • warning

      added the new earn_incentive_claim enum value to the ///// response property for the response status

    • warning

      added the new earn_incentive_claim enum value to the //// response property for the response status

    • warning

      added the new earn_incentive_claim enum value to the /// response property for the response status

    • warning

      added the new earn_incentive_claim enum value to the ///// response property for the response status

    • warning

      added the new earn_incentive_claim enum value to the //// response property for the response status

    • warning

      added the new earn_incentive_claim enum value to the //// response property for the response status

    • info

      added the new earn_incentive_claim enum value to the request property

  • bc6468dfd728Revision changes
    • breaking

      the /// response property's maxLength was increased from 50 to 100 for the response status