Update end-user API key permissions

• POST /api/v3/accountCenter/apiKey/permissions

Weight(IP): 5

Updates the permissions, IP allowlist, and remark for specified end-users API key. If the updated permissions include any non-read-only permission, an IP allowlist is required.

Request parameters

Parameter	Type	Required?	Description
subUserId	Long	Yes	End-user UID.
apiKey	String	Yes	API key to update.
authorities	String[]	Yes	Updated API key permissions.
ipWhiteList	String[]	Conditional	IP allowlist (up to 10 entries). Required if any non-read-only permission is enabled.
remark	String	No	API key remark.

API key permission enums

Permission	Description
ACCOUNT_DETAILS	Read-only access to account details.
SPOT_TRADING	Spot trading permission.
FUTURES_TRADING	Futures trading permission.
TRANSFER	Fund transfer permission.
WITHDRAW	Withdrawal permission.

Request example

{
  "subUserId": 1234567890,
  "apiKey": "weex_xxxxxxxxxxxxxxxxxxxxxxxx",
  "authorities": ["ACCOUNT_DETAILS"],
  "ipWhiteList": [],
  "remark": "readonly key"
}

Response parameters

Field name	Type	Description
subUserId	Long	End-user UID.
authorities	String[]	Updated API key permissions.
ipWhiteList	String[]	Updated IP allowlist.
ts	Long	Operation success timestamp in milliseconds.

Response example

{
  "subUserId": 1234567890,
  "authorities": ["ACCOUNT_DETAILS"],
  "ipWhiteList": [],
  "ts": 1780000000000
}