Connected Accounts

Rename Connected Account

Rename a connected account by account ID.

post/connected_accounts/{accountId}/rename

Request

Path parameters

accountIdstring required

The unique identifier of the connected account

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

accountNamestring required

The new name for the connected account

Example request

{
  "accountName": "My Trading Account"
}

Response

Successfully renamed connected account.

'SUCCESS' | 'UNAUTHORISED__USER' | 'UNAUTHORISED__DEVICE' | 'INVALID_UNMANAGED_WALLET' | 'INVALID_EXCHANGE_ACCOUNT' | 'NO_ACTIVE_ADMINS' | 'TIMEOUT' | 'INVALID_PARAMETERS' | 'INTERNAL_ERROR' | 'INVALID_CREDENTIALS' | 'INVALID_OTP' | 'INVALID_OTP_METHOD' | 'INVALID_NETWORK_CONNECTION' | 'NETWORK_CONNECTION_EXISTS' | 'INVALID_CREDENTIALS__UNSUPPORTED_PROVIDER' | 'UNSUPPORTED_ALGORITHM' | 'INVALID_CREDENTIALS__IP_WHITELISTING' | 'INVALID_CREDENTIALS__OTP_FAILED' | 'UNSUPPORTED_ASSET' | 'ASSET_ALREADY_EXISTS' | 'ENV_UNSUPPORTED_ASSET' | 'NO_CONFIG_CHANGE_NEEDED' | 'SIMILAR_REQUEST_ALREADY_PENDING' | 'CLOUD_COSIGNER_ALREADY_EXISTS' | 'ILLEGAL_OPERATION' | 'OVERRIDING_PENDING_REQUEST' | 'OWNER_NOT_IN_GROUP' | 'INVALID_THIRD_PARTY_ACCOUNT_HIERARCHY' | 'EXTERNAL_KEY_VALIDATION_FAILED' | 'NO_AVAILABLE_EXTERNAL_KEYS' | 'INVALID_PROOF_OF_OWNERSHIP_SIGNATURE' | 'USER_HAS_EXTERNAL_KEYS' | 'SCHEMA_ALREADY_EXISTS' | 'SCHEMA_ID_OUT_OF_RANGE' | 'FORBIDDEN_SSO_IDP_DOMAIN' | 'UNKNOWN_ERROR' required

Status of the rename operation

Example response

"SUCCESS"

Changes

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