Create a SUI unstake request

post

https://your-protect-instance.example.com/api/rest/v1/requests/outgoing/sui/unstake

This endpoint creates a request that withdraws stake from the selected stake object back to the address balance, in full or in part. Principal plus accrued rewards are returned; withdrawal is immediate (no unbonding period).
Required role: RequestCreator.

Body Params

fromAddressId

string

required

The ID of the SUI address that owns the stake object.

stakeObjectId

string

required

The object ID of the stake object to unstake, as returned by the stake_accounts endpoint.

amount

string

The amount of principal to unstake, in MIST. If 0 or unspecified, the whole stake object is withdrawn. Otherwise the stake object is split and only this amount is withdrawn; both the withdrawn part and the remainder must be at least 1 SUI (1000000000 MIST). Accrued rewards on the withdrawn part are paid out on top.

comment

string

Comment to be added to the request trail.

externalRequestId

string

Identifier for the request in the user's system. This must be unique. Attempting to create a request with an existing externalRequestId will do nothing and return the originally created request

Responses

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.