TAtatum
Subscriptions

Update alert

This endpoint is compatible with our deprecated v3 Notifications product. To use it with v3, simply replace 'v4' with 'v3' in the request URL.

<p style="display: none">/v4/subscription/{id}</p> <p>Update alert.</p>
put/v4/subscription/{id}

Request

  • Base URL
    https://api.tatum.io
  • URL
    https://api.tatum.io/v4/subscription/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required
Example:5e68c66581f2ee32bc354087

Alert ID

Request body

urlstring

URL of the endpoint, where HTTP POST request will be sent.

mempoolboolean

Flag indicating whether the alert should include mempool transactions. Only available on BTC blockchain.

pausedboolean

Flag indicating whether the alert should be paused or resumed.

finality'confirmed' | 'final'

Choose between speed (confirmed) and block confirmations on chain (final). Supported only on the chains GET /v4/subscription/chains reports with finality true.

templateId'enriched' | 'enriched_with_raw_data' | 'legacy' | '68b825be1aa0da023d4c9018 (custom template)'

Configure the response format. Supported only on the chains GET /v4/subscription/chains reports with finality true.

Example request

{
  "url": "https://dashboard.tatum.io/webhook-handler",
  "finality": "confirmed",
  "templateId": "enriched"
}

Response

OK

Changes

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