Sign in

v2

latestOpenAPI 3.0.4Commercial License2026-08-0718678294.5 KB
Subscriptions

Update a price watch

Update the configurable fields of one price watch owned by the authenticated account.

patch/v1/subscriptions/{id}

Path parameters

idstring required
Example:018f47a2-4d4d-7a44-9fa4-123456789abc

Resource identifier.

Request body

namestring
codesstring[]
codestring

Legacy single-code shorthand; folded into codes.

interval_secondsinteger

Evaluation interval in seconds, subject to the account tier's minimum.

deliver_webhookboolean
status'active' | 'paused'

Example request

{
  "name": "My energy watch",
  "codes": [
    "WTI_USD"
  ],
  "code": "WTI_USD",
  "interval_seconds": 900,
  "deliver_webhook": true,
  "status": "active"
}

Response

Subscription updated

status'success' required

Example response

{
  "status": "success",
  "data": {
    "subscription": {
      "id": "018f47a2-4d4d-7a44-9fa4-123456789abc",
      "name": "My WTI watch",
      "codes": [
        "WTI_USD",
        "BRENT_CRUDE_USD"
      ],
      "interval_seconds": 3600,
      "status": "active",
      "source": "api",
      "tool_name": "watch_commodity"
    }
  }
}