Update a stream subscription

put

https://api.canton.noves.fi/{chain}/streams/{id}

Updates one or more fields on an existing subscription. Only the fields you include in the
request body are changed — omitted fields are left as-is.

Common operations:

Change webhook URL: set webhookUrl to the new URL.
Remove webhook delivery: set webhookUrl to an empty string (subscription must have websocket enabled).
Pause delivery: set active to false. Pending webhooks are held until you resume.
Resume delivery: set active to true.
Change filters: set partyFilter and/or filters. See the create endpoint for available filter types.

At least one delivery method (webhook or websocket) must remain enabled after the update.

Path Params

chain

string

required

Defaults to canton

Name of the chain.

uuid

required

Subscription ID (UUID).

Body Params

Fields to update (only provided fields are changed).

webhookUrl

string | null

New webhook URL. Set to empty string "" to remove webhook delivery.

websocketEnabled

boolean | null

Enable or disable WebSocket delivery.

partyFilter

string | null

New party filter. Set to empty string "" to clear and receive updates for all parties.

filters

object

Structured subscription filters. Categories are OR'd.

includeRawData

boolean | null

Enable or disable raw transaction data in deliveries.

active

boolean | null

Set to false to pause delivery (pending webhooks are held), or true to resume.

Headers

apiKey

string

required

Defaults to demokey

API Key to call the API. To generate one, visit https://noves.fi/pricing

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

404Not Found