OIoilpriceapi
Subscriptions

Pause a price watch

Pause evaluation of one price watch owned by the authenticated account.

post/v1/subscriptions/{id}/pause

Request

  • Base URL
    https://api.oilpriceapi.com
  • Auth
    API key in header Authorization

Path parameters

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

Price watch identifier.

Response

Price watch paused

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"
    }
  }
}

Changes

No recorded changes to this operation across all 17 revisions of this API.