Update agent policy

Partially update an agent’s policy. Only provided fields will be updated; omitted fields retain their current values. Policy changes take effect immediately.

PATCH /agents/{agentId}/policy

cURL

cURL

curl --request PATCH \
  --url https://api.lightspark.com/grid/2025-10-13/agents/{agentId}/policy \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "permissions": [],
  "spendingLimits": {
    "currency": "USD",
    "perTransactionLimit": 50000,
    "dailyLimit": 500000,
    "dailyTransactionLimit": 10,
    "monthlyLimit": 5000000
  },
  "accountRestrictions": {
    "allowedAccountIds": [
      "Account:019542f5-b3e7-1d02-0000-000000000001"
    ],
    "accountRules": [
      {
        "accountId": "Account:019542f5-b3e7-1d02-0000-000000000001",
        "perTransactionLimit": 10000
      }
    ]
  },
  "approvalThresholds": {
    "currency": "USD",
    "amount": 100000
  }
}
'

import LightsparkGrid from '@lightsparkdev/grid';

const client = new LightsparkGrid({
  username: process.env['GRID_CLIENT_ID'], // This is the default and can be omitted
  password: process.env['GRID_CLIENT_SECRET'], // This is the default and can be omitted
});

const agent = await client.agents.updatePolicy('agentId');

console.log(agent.id);

package com.lightspark.grid.example

import com.lightspark.grid.client.LightsparkGridClient
import com.lightspark.grid.client.okhttp.LightsparkGridOkHttpClient
import com.lightspark.grid.models.agents.Agent
import com.lightspark.grid.models.agents.AgentPolicyUpdateRequest
import com.lightspark.grid.models.agents.AgentUpdatePolicyParams

fun main() {
    val client: LightsparkGridClient = LightsparkGridOkHttpClient.fromEnv()

    val params: AgentUpdatePolicyParams = AgentUpdatePolicyParams.builder()
        .agentId("agentId")
        .agentPolicyUpdateRequest(AgentPolicyUpdateRequest.builder().build())
        .build()
    val agent: Agent = client.agents().updatePolicy(params)
}

200

{
  "id": "Agent:019542f5-b3e7-1d02-0000-000000000001",
  "name": "Payroll Automation Agent",
  "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
  "isPaused": false,
  "isConnected": true,
  "policy": {
    "permissions": [],
    "spendingLimits": {
      "currency": "USD",
      "perTransactionLimit": 50000,
      "dailyLimit": 500000,
      "dailyTransactionLimit": 10,
      "monthlyLimit": 5000000
    },
    "accountRestrictions": {
      "allowedAccountIds": [
        "Account:019542f5-b3e7-1d02-0000-000000000001"
      ],
      "accountRules": [
        {
          "accountId": "Account:019542f5-b3e7-1d02-0000-000000000001",
          "perTransactionLimit": 10000
        }
      ]
    },
    "approvalThresholds": {
      "currency": "USD",
      "amount": 100000
    }
  },
  "usage": {
    "dailyTransactionCount": 3,
    "dailySpend": 150000,
    "monthlySpend": 750000,
    "dailyResetDate": "2025-07-22",
    "monthlyResetMonth": "2025-08"
  },
  "createdAt": "2025-07-21T17:32:28Z",
  "updatedAt": "2025-07-21T17:32:28Z"
}

{
  "status": 400,
  "message": "<string>",
  "details": {}
}

{
  "status": 401,
  "message": "<string>",
  "details": {}
}

{
  "status": 404,
  "message": "<string>",
  "details": {}
}

{
  "status": 500,
  "message": "<string>",
  "details": {}
}

Authorizations

Authorization · string · header · required

API token authentication using format <api token id>:<api client secret>

Path Parameters

agentId · string · required

System-generated unique agent identifier

Body

application/json

Partial update to an agent's policy. Only provided fields will be updated; omitted fields retain their current values.

permissions · enum<string>[]

Updated list of permissions. Replaces the entire permissions list when provided.

Permission granted to an agent that determines what actions it can perform. VIEW_TRANSACTIONS: Can list and retrieve transactions and account balances. CREATE_TRANSFERS: Can initiate same-currency transfers. CREATE_QUOTES: Can create cross-currency quotes. EXECUTE_QUOTES: Can execute cross-currency quotes. MANAGE_EXTERNAL_ACCOUNTS: Can create and manage external accounts.

Available options: VIEW_TRANSACTIONS, CREATE_TRANSFERS, CREATE_QUOTES, EXECUTE_QUOTES, MANAGE_EXTERNAL_ACCOUNTS

defaultExecutionMode · enum<string>

Execution mode controlling whether agent actions require human approval. AUTO: The agent can execute actions autonomously without explicit approval. APPROVAL_REQUIRED: All agent actions require explicit human approval before execution.

Available options: AUTO, APPROVAL_REQUIRED

spendingLimits · object

Partial update to spending limits. Only provided fields will be updated; omitted fields retain their current values.

Show child attributes

accountRestrictions · object

Optional restrictions that limit the agent to specific accounts or override policy per account.

Show child attributes

approvalThresholds · object

Thresholds that force approval for high-value transactions, overriding the default execution mode. When a transaction is denominated in a different currency than the threshold, Grid converts using the exchange rate at evaluation time.

Show child attributes

Response

200

application/json

Agent policy updated successfully

A programmatic agent with scoped permissions and a spending policy, used to automate payment workflows.

id · string · required

System-generated unique identifier for the agent.

Example:

"Agent:019542f5-b3e7-1d02-0000-000000000001"

name · string · required

Human-readable name for the agent.

Example:

"Payroll Automation Agent"

customerId · string · required

The ID of the customer this agent operates on behalf of.

Example:

"Customer:019542f5-b3e7-1d02-0000-000000000001"

isPaused · boolean · required

Whether the agent is currently paused. Paused agents cannot initiate any actions.

Example:

false

isConnected · boolean · required

Whether the agent has been installed and connected (i.e., its device code has been redeemed).

Example:

true

policy · object · required

Policy governing what an agent can do, how it executes actions, and its spending boundaries.

Show child attributes

usage · object · required

Real-time counters tracking the agent's spending and transaction activity against its policy limits.

Show child attributes

createdAt · string<date-time> · required

Creation timestamp.

Example:

"2025-07-21T17:32:28Z"

updatedAt · string<date-time> · required

Last update timestamp.

Example:

"2025-07-21T17:32:28Z"