programUnsubscribe

programUnsubscribe — Cancel a program subscription

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. Parameters

  1. subscriptionId (required) — Subscription id returned by programSubscribe.

Authorizations
AuthorizationstringOptional

Pass Authorization: <api-key> on each request.

Body
jsonrpcstring · enumRequired

JSON-RPC protocol version.

Example: 2.0Possible values:
idone ofRequired

Request identifier echoed back in the response.

Example: 1
stringOptional
or
integerOptional
methodstring · enumRequired

Must be programUnsubscribe.

Example: programUnsubscribePossible values:
Responses
200

Successful programUnsubscribe response.

application/json

Base envelope of every JSON-RPC 2.0 response.

jsonrpcstring · enumRequiredExample: 2.0Possible values:
idone ofRequired

Echoed request id.

Example: 1
stringOptional
or
integerOptional
resultbooleanRequired

True if the unsubscribe succeeded.

Example: true
post
/

Last updated