Sign in
Agents

Update an agent

Change name, description, limits, destination allowlist, or pause / resume. customerId, sourceAccountId, and limits.currency are immutable — create a new agent to change them. Limit changes apply to the next transfer; active keys pick up allowlist changes immediately.

patch/v1/agents/{id}

Path parameters

idstring required

Headers

X-API-Keystring

API key

Request body

namestring
descriptionstring nullable
allowedDestinationAccountIdsstring[] nullable

Replaces the allowlist. null clears it (any approved destination of the customer).

status'ACTIVE' | 'PAUSED'

Pause or resume. Use DELETE /v1/agents/{id} to revoke.

metadataobject

Example request

{
  "limits": {
    "currency": "USD",
    "perTransaction": "100000",
    "perDay": "500000",
    "perMonth": "1000000"
  }
}

Response

idstring required
namestring required
descriptionstring nullable required
customerIdstring required
sourceAccountIdstring required
allowedDestinationAccountIdsstring[] nullable required
status'ACTIVE' | 'PAUSED' | 'REVOKED' required
metadataobject required
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "id": "agt_abc123",
  "name": "Procurement Agent",
  "description": "Buys supplies",
  "customerId": "cus_abc123",
  "sourceAccountId": "vba_agent_balance",
  "allowedDestinationAccountIds": [
    "eba_vendor456"
  ],
  "limits": {
    "currency": "USD",
    "perTransaction": "100000",
    "perDay": "500000",
    "perMonth": "1000000"
  }
}

Changes

Changed in 1 of the 19 revisions of this API.1