/{chain}/streams/{id}

put

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

Updates the supplied fields on an existing subscription. Omitted fields remain unchanged.

Common operations:

Change webhook URL: set webhookUrl to the new URL.
Remove webhook delivery: set webhookUrl to an empty string (subscription must have WebSocket delivery 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

Canton chain name. Use a name returned by GET /chains.

uuid

required

Subscription ID (UUID).

Body Params

Subscription fields to update.

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 | null

Replace the subscription's filters. See create endpoint for structure.

includeRawData

boolean | null

Enable or disable raw update 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 for Canton API. To generate an API Key, visit https://app.noves.fi

Responses

200Success