Subscriptions

Change URL, online/offline status, billed key, chains or confirmation depths.

JSON Merge Patch keyed by chain. An object adds a chain or changes its confirmations; null removes it. An existing chain with omitted confirmations keeps its value, a new chain uses its default. Repeating the patch changes nothing. Removing the last chain is 422 chains_required. key_id must be another active key of the same account. The response includes change_version; compare it with applied_version.

patch/push/subscriptions/{subscription_id}

Request

  • Base URL: https://api.blockvectra.com/v1
  • URL: https://api.blockvectra.com/v1/push/subscriptions/{subscription_id}
  • Auth: API key in header x-api-key

Request body

urlstring

https, port 443, a host name (no IP literal), no userinfo or fragment; stored and returned normalized.

status'online' | 'offline'
key_idstring
chainsobject

Merge patch keyed by chain: an object adds the chain or changes its N, null removes it.

Response

The subscription after the patch, with the version of this change.

idinteger required

The subscription id: the one number that identifies a subscription everywhere (PostgreSQL integer identity, fits u32, never reused). A plain JSON integer in bodies, decimal digits in the path.

urlstring required

https, port 443, a host name (no IP literal), no userinfo or fragment; stored and returned normalized.

status'online' | 'offline' required

online listens and delivers; offline does not listen (addresses unloaded, no matching, delivery or address fee) and keeps its whole configuration, and can go online again at any time. Change it with PATCH; the system also sets offline when the subscription expires (a chain failed for the expiry window, currently 7 days, and no other chain delivered inside it).

key_idstring required
address_countinteger required

Distinct addresses of this subscription; additions cannot exceed 1,000,000. Existing oversized subscriptions can remove addresses and resend existing addresses.

applied_versioninteger required

Address and chain changes of this subscription up to this version are applied on every chain; compare with change_version returned by add, remove and PATCH (a counter of this subscription only).

chainsobject required
created_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.