updateSubscriptionParams

Update the parameters supplied to a currently active subscription. This is commonly used to update the filters on the priceUpdated subscription.

This method will reset all of the parameters of the subscription with the supplied parameters.

Request Parameters

subscription_id
unsigned integer
The subscription id of the active subscription you want to update the parameters of.
update
multiple
The update object is used to contain the new parameters for the subscription. The structure is the same as the parameters listed on the subscribe documentation page. E.g. for swapSubscribe, this should contain a filter object.

Response Fields

<boolean>
boolean
True when params have been successfully updated.

Request Example

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "updateSubscriptionParams",
    "params": {
        "subscription_id": 1,
        "update":{
            "include": {
                "walletAccount": [
                    "E1wid5KyTfkzxWDUmhxhJTKZqVRR4N6kyuTLXB5bPiU"
                ]
            }
        }
    }
}

Response Example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": true
}