POST/api/v1/address/update

Update Sub-address Information

Update an existing sub-address alias, status (enabled/disabled), or deposit callback URL. Disabled sub-addresses cannot be used as fund collection sources.

Rate limit: 1000 requests/minute

Request

Request Body

required

application/json

noncestringrequired
6-character random string.
timestampinteger<int64>required
Timestamp.
signstringrequired
Signature.
pidinteger<int64>required
Project ID.
addressstringrequired
Project address to update.
aliasstring
Address display name. At least one of callback_url, alias, or status must be provided.
statusstring
enum: "0", "1"
Address status
- 0enabled
- 1disabled
At least one of callback_url, alias, or status must be provided.
callback_urlstring
Callback URL. At least one of callback_url, alias, or status must be provided.

Responses

200Success

application/json

codestring
Response code.
msgstring
Response message.
dataany
Response data.