Rotate the deposit address
Queues a replacement of the deposit address. The new address is assigned automatically, usually within 5 minutes.
Once the rotation completes, the previous address stops accepting deposits. So withdraw the remaining balance from it before requesting the rotation, and update your address in every external system afterwards.
You may always rotate your own address; a parent account may rotate its sub-user's; someone else's address cannot be rotated.
Only one rotation may be queued per user and address type within seven days; a repeat request is rejected with 409.
Authorizations
API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.
Parameters
Header Parameters
An IP address from the key's whitelist. A request from an address outside the whitelist is rejected with 401.
"203.0.113.10""ipv4"Request Body
Responses
The request was queued.