Skip to main content

Modify Subaccount

Frequency limit: 1 time/1s (API Key)

Description

Modify status and permissions of subaccounts

HTTP Request

  • POST /api/v2/broker/account/modify-subaccount
Request Example
curl -X POST "https://api.bitget.com/api/v2/broker/account/modify-subaccount" \
-H "ACCESS-KEY:your apiKey" \
-H "ACCESS-SIGN:*" \
-H "ACCESS-PASSPHRASE:*" \
-H "ACCESS-TIMESTAMP:1659076670000" \
-H "locale:zh-CN" \
-H "Content-Type: application/json" \
-d '{"subUid":"111222","permList":["transfer"],"status":"normal","language":"en_US"}'

Request Parameters

ParameterTypeRequiredDescription
subUidStringYesSubaccount user id
permListList<String>YesPermissions
withdraw
transfer
spot_trade
contract_trade
read
deposit
margin_trade: spot margin
statusStringYesSubaccount Status

normal: normal status
freeze:freeze status
languageStringNoSubaccount language
en_US
zh_CN
ja_JP
vi_VN
zh_TW
ru_RU
es_ES
tr_TR
fr_FR
de_DE
pt_PT
th_TH
Response example
{
"code": "00000",
"msg": "success",
"requestTime": 1695784726115,
"data": {
"subUid": "*********",
"subaccountName": "**********",
"status": "normal",
"permList": [
"transfer"
],
"label": "old remark",
"language": "en_US",
"cTime": "1692008679489",
"uTime": "1695784728684"
}
}

Response Parameters

ParameterTypeDescription
subUidStringSubaccount user id
subaccountNameStringUsername in email format generated by subaccountName as the prefix
statusStringSubaccount Status
normal
freeze
permListList<String>Permissions
withdraw
transfer
spot_trade
contract_trade
read
deposit
labelStringLabel
ctimeStringCreation time
Unix millisecond timestamp, e.g. 1690196141868
utimeStringUpdate time
Unix millisecond timestamp, e.g. 1690196141868
languageStringSubaccount language
en_US
zh_CN
ja_JP
vi_VN
zh_TW
ru_RU
es_ES
tr_TR
fr_FR
de_DE
pt_PT
th_TH

How was your Reading Experience with us?