Update agent
Update an agent’s name, paused state or spending pool.
Authorizations
API token authentication using format <api token id>:<api client secret>
Path Parameters
System-generated unique agent identifier
Body
Partial update to an agent's basic fields. At least one field must be provided.
Updated name for the agent.
"Updated Payroll Agent"
Set to true to pause the agent or false to resume it.
true
Move the agent to this spending pool of the same customer, or take it out of its pool with null. Available where the platform enables spending pools. The agent's policy must be in the pool's currency.
"SpendingPool:019542f5-b3e7-1d02-0000-000000000007"
Response
Agent updated successfully
A programmatic agent with scoped permissions and a spending policy, used to automate payment workflows.
System-generated unique identifier for the agent.
"Agent:019542f5-b3e7-1d02-0000-000000000001"
Human-readable name for the agent.
"Payroll Automation Agent"
The ID of the customer this agent operates on behalf of.
"Customer:019542f5-b3e7-1d02-0000-000000000001"
Whether the agent is currently paused. Paused agents cannot initiate any actions.
false
Whether the agent has been installed and connected (i.e., its device code has been redeemed).
true
Policy governing what an agent can do, how it executes actions, and its spending boundaries.
Real-time counters tracking the agent's spending and transaction activity against its policy limits.
Creation timestamp.
"2025-07-21T17:32:28Z"
Last update timestamp.
"2025-07-21T17:32:28Z"
The platform's reference for the person this agent acts for, as given when the agent was created. Absent when none was given.
"member_8f2c1a"
The spending pool the agent spends under, in addition to its own policy. Absent when the agent is in no pool.
"SpendingPool:019542f5-b3e7-1d02-0000-000000000007"