Skip to main content
PATCH
Update agent

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 basic fields. At least one field must be provided.

name
string

Updated name for the agent.

Example:

"Updated Payroll Agent"

isPaused
boolean

Set to true to pause the agent or false to resume it.

Example:

true

spendingPoolId
string | null

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.

Example:

"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.

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.

usage
object
required

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

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"

actingFor
string

The platform's reference for the person this agent acts for, as given when the agent was created. Absent when none was given.

Example:

"member_8f2c1a"

spendingPoolId
string

The spending pool the agent spends under, in addition to its own policy. Absent when the agent is in no pool.

Example:

"SpendingPool:019542f5-b3e7-1d02-0000-000000000007"