Create a price alert definition

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  AccountId	String	Body	The account that owns this price alert definition.
  AssetType	AssetType	Body	The type of instrument that this alert is monitoring.
  Comment	String	Body	An optional comment associated with the price alert definition. The maximum supported length of the string is 128 characters.
  ExpiryDate	UtcDateTime	Body	The UTC date and time that the price alert definition will expire and then be removed from the system. The date and time is specified in Coordinated Universal Time (UTC) and should be formatted as "yyyy-mm-ddThh:mm:ssZ".
  IsExtendedHours	Boolean	Body	An optional flag to indicate if price alert definition is valid in extended hours trading. Default will be set to false.
  IsRecurring	Boolean	Body	Is the alert only triggered once or will the alerts keep recurring until the alert expires.
  Operator	PriceAlertComparisonOperator	Body	The boolean operator used to compare the current price with the defined value.
  PriceVariable	PriceVariable	Body	The aspect of the price that is being monitored.
  State	PriceAlertDefinitionState	Body	A price alert definition can be enabled, disabled or suspended. RecentlyTriggered is used for recurring alerts, so that they don't trigger constantly once the condition has been met.
  TargetValue	Number	Body	The value that the current price is compared to.
  Uic	Integer	Body	Universal Instrument Code (UIC).

• Response Parameters

  View Response Codes

  Name	Type	Description
  AccountId	String	The account that owns this price alert definition.
  AlertDefinitionId	String	The ID of this .
  AssetType	AssetType	The type of instrument that this alert is monitoring.
  ClientId	String	The client that owns this price alert definition.
  Comment	String	An optional comment associated with the price alert definition. The maximum supported length of the string is 128 characters.
  ExpiryDate	UtcDateTime	The UTC date and time that the price alert definition will expire and then be removed from the system. The date and time is specified in Coordinated Universal Time (UTC) and should be formatted as "yyyy-mm-ddThh:mm:ssZ".
  IsExtendedHours	Boolean	An optional flag to indicate if price alert definition is valid in extended hours trading. Default will be set to false.
  IsRecurring	Boolean	Is the alert only triggered once or will the alerts keep recurring until the alert expires.
  Operator	PriceAlertComparisonOperator	The boolean operator used to compare the current price with the defined value.
  PriceVariable	PriceVariable	The aspect of the price that is being monitored.
  State	PriceAlertDefinitionState	A price alert definition can be enabled, disabled or suspended. RecentlyTriggered is used for recurring alerts, so that they don't trigger constantly once the condition has been met.
  TargetValue	Number	The value that the current price is compared to.
  Uic	Integer	Universal Instrument Code (UIC).
  UserId	String	The ID of the user that owns this price alert definition.

  HTTP Code	Description
  201	Created	Created
  400	Bad Request	Error Code Description InvalidInput An error was encountered when processing given input parameters. NoValidInput No valid input values passed. PriceAlertIdsDoNotMatch Given Ids do not match UserSettingsCacheNothingToFlush There were no user settings to flush from the cache.
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable.

  Close

• Request Example

  Request URL

  POST /vas/v1/pricealerts/definitions

  Request Body

  {
    "AccountId": "13457INET",
    "AssetType": "FxSpot",
    "Comment": "I believe EURUSD will go up within the next few years!",
    "ExpiryDate": "2016-09-30T12:00:00Z",
    "IsRecurring": true,
    "Operator": "GreaterOrEqual",
    "PriceVariable": "AskTick",
    "State": "Enabled",
    "TargetValue": 1.34595,
    "Uic": 21
  }
  

• Response Example

  Response body

  {
    "AccountId": "13457INET",
    "AlertDefinitionId": "30834",
    "AssetType": "FxSpot",
    "Comment": "I believe EURUSD will go up within the next few years!",
    "ExpiryDate": "2016-09-30T12:00:00Z",
    "IsRecurring": true,
    "Operator": "GreaterOrEqual",
    "PriceVariable": "AskTick",
    "State": "Enabled",
    "TargetValue": 1.34595,
    "Uic": 21,
    "UserId": "2361528"
  }