News API

Create or update a standing calendar alert rule

A rule such as "notify me 30 minutes before every HIGH impact USD event". The 30 minute calendar sync turns it into ordinary alerts, so a change takes effect on the next sync and any alert the previous version had already materialised is dropped.

post/rest/api/v1/projects/{projectId}/calendarAlertRules

Path parameters

projectIdstring uuid required

Request body

createdAtstring date-time

Creation time

createdByEmailstring

Who created the rule, provenance only and never a scope

currencyCodesstring[]

Currencies the rule reacts to. Empty matches every currency.

enabledboolean

A disabled rule stops materialising new alerts

idstring

MongoDB document id

includeMarketNewsboolean

Also send HIGH impact market news headlines matching the currencies of this rule. Those have no lead time, they are announced when they are summarised.

leadMinutesinteger[]

Minutes before the event the alerts fire

minImpact'HOLIDAY' | 'LOW' | 'MEDIUM' | 'HIGH'

Lowest impact the rule reacts to

namestring

Label shown in the alerts panel

projectIdstring uuid

Owning project

Example request

{
  "leadMinutes": [
    30
  ],
  "name": "High impact USD",
  "notificationTargets": [
    {
      "recipient": "@john"
    }
  ]
}

Response