Docs
Api referenceAlerts

Change an alert hook's name, accounts or defaults

PATCH
/v1/alert-hooks/{id}

The URL does not change, so nothing needs editing in TradingView. defaults fields you send replace those fields; the rest stay as they are. symbolMap, when sent, replaces the whole map.

Authorization

apiKey
AuthorizationBearer <token>

Authorization: Bearer fx_live_<id>_<secret>.

A key is shown once, at creation. We cannot show it again or recover it for you. Keys carry a label (live or test) in the key itself, so each configuration is easy to tell apart. Both reach real brokers: test with a broker demo account.

Scopes are per key. A key without accounts:write can read accounts and nothing else.

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/alert-hooks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "accountIds": [      "b75e4440-1cc9-49a6-8c9e-087e1aa69722"    ],    "defaults": {      "volume": "0.10",      "deviationPoints": 20,      "symbolMap": {        "XAUUSD": "XAUUSD.a",        "US30": "DJ30"      },      "symbolSuffix": ".a",      "stripExchangePrefix": true,      "allowClose": true,      "onlyTradingViewIps": true    },    "enabled": true,    "urlHint": "https://api.fxapis.com/hooks/tradingview/…Qx4w",    "lastUsedAt": null,    "createdAt": "2019-08-24T14:15:22Z"  }}