Skip to navigation
Agora Public APIEndpointsAccounts

Update an Account

Apply a single change to an existing account, selected by operation:

  • setName: rename a wallet or bank account (send name).
  • addNetwork: register an existing wallet on an additional network, which starts a new mint entitlement there (see Wallet entitlements). Rejected with 409 if the address is already registered there.
  • requestEntitlement: request an entitlement (currently instant_settlement) on an existing wallet network. Returns 400 if the entitlement isn’t requestable for that network. See Wallet entitlements for how requests are reviewed and approved.

The response is the full updated account, same shape as GET /v0/accounts.

Authentication

AuthorizationBearer

Session JWT from POST /v0/auth/token, sent as Authorization: Bearer <sessionJwt>.

See Authentication for more details.

Path parameters

accountIdstringRequiredformat: "uuid"

Id of the account to update; must belong to the caller's org.

Request

This endpoint expects an object.
operationenumRequired
Allowed values:
namestringOptional<=200 characters

User-set label. Free-form; max 200 characters.

networkenumOptional
entitlementenumOptional

Entitlement to request. Moves to pending_approval; granting stays Agora-side.

Allowed values:

Response

OK
Walletobject

Customer-owned blockchain address (CustomerAddress).

OR
Bank Accountobject

Customer-owned bank account (WireDetail, status=verified).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error