Sign in
Accounts

Update an Account

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

put/v0/accounts/{accountId}

Path parameters

accountIdstring uuid required

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

Headers

Authorizationstring required

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

See Authentication for more details.

Request body

operation'setName' | 'addNetwork' | 'requestEntitlement' required
namestring

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

network'arbitrum' | 'avalanche' | 'base' | 'binance-smart-chain' | 'core' | 'ethereum' | 'fraxtal' | 'gnosis' | 'immutable' | 'injective' | 'katana' | 'mantle' | 'monad' | 'plume' | 'polygon-pos' | 'solana' | 'sui'
entitlement'instant_settlement'

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

Response

OK

OR

Changes

Changed in 2 of the 3 revisions of this API.3

  • 72979de2c6951See the full diff
    • ●

      the name request property's maxLength was set to 200

      request-property-max-length-set

  • 8525bfff76342See the full diff
    • ●

      added the new account_not_provisioned enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new account_verification_pending enum value to the code response property for the response status 403

      response-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog