GEgemini
Account Administration

Rename Account

A Master or Account level API key can rename an account within the group.

Roles

The API key you use to access this endpoint can be either a Master or Account level API key and must have the Administrator role assigned. See Roles for more information.

post/v1/account/rename

Request

  • Base URL
    https://api.gemini.com
  • URL
    https://api.gemini.com/v1/account/rename
  • Auth
    API key in header X-GEMINI-APIKEY and API key in header X-GEMINI-SIGNATURE and API key in header X-GEMINI-PAYLOAD

Headers

X-GEMINI-APIKEYstring required

Your API key

X-GEMINI-SIGNATUREstring required

HEX-encoded HMAC-SHA384 of payload signed with API secret

X-GEMINI-PAYLOADstring required

Base64-encoded JSON payload

Content-Typestring
Content-Lengthstring
Cache-Controlstring

Request body

requeststring required

The literal string "/v1/account/rename".

accountstring

Only required when using a master api-key. The shortname of the account within the subaccount group. Master API keys can get all account shortnames from the account field returned by the Get Accounts endpoint.

newNamestring

A unique name for the new account. If not provided, name will not change.

newAccountstring

A unique shortname for the new account. If not provided, shortname will not change.

Example request

{
  "nonce": "1495127793000"
}

Response

An element containing the updated name of the account.

namestring

New name for the account based off the provided newName field. Only returned if newName was provided in the request.

accountstring

New shortname for the account based off the provided newAccount field. Only returned if newAccount was provided in the request.

Changes

No recorded changes to this operation across all 1 revision of this API.