Agora Public APIEndpointsAccounts

Update an Account

Beta
<Callout intent="warning"> The endpoints exposed here are currently in **Beta**! As we continue to build our initial offering, these endpoints may implement breaking changes. Be sure to check back for our change log regularly as a precaution. </Callout> 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](/api/endpoints/accounts/overview#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](/api/endpoints/accounts/overview#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>.

Path parameters

accountIdstringRequiredformat: "uuid"

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
object

Customer-owned blockchain address (CustomerAddress).

OR
object

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