programUnsubscribe

programUnsubscribe WebSocket Method

post
/

Unsubscribe from program-owned account change notifications. This method cancels an existing program subscription identified by the subscription ID that was returned from a previous programSubscribe call. Once unsubscribed, you will no longer receive programNotification messages for accounts owned by the specified program.

Authorizations
AuthorizationstringOptional

Authorization header for API key authentication.

Example:

Authorization: your-api-key-here
Body

Request object for unsubscribing from program account change notifications

jsonrpcstring · enumRequired

JSON-RPC protocol version

Example: 2.0Possible values:
idone ofRequired

Request identifier that will be returned in the response

Example: 1
stringOptional
or
numberOptional
methodstring · enumRequired

The WebSocket method name

Example: programUnsubscribePossible values:
paramsinteger[] · min: 1 · max: 1Required

Method parameters array containing the program subscription ID to cancel

Example: [24040]
Responses
chevron-right
200

Unsubscription successful

application/json

Response indicating the success or failure of the program unsubscribe operation

jsonrpcstring · enumRequired

JSON-RPC protocol version

Example: 2.0Possible values:
idone ofRequired

Request identifier matching the original request

Example: 1
stringOptional
or
numberOptional
resultbooleanOptional

Unsubscribe success indicator. Returns true if the program subscription was successfully cancelled, false otherwise. A successful unsubscribe means you will no longer receive programNotification messages for accounts owned by the subscribed program.

Example: true
post
/

Last updated