Examples

POST /api/v2/alerts
{
  "data": {
    "type": "alerts",
    "attributes": {
      "name": "My first alert",
      "frequency": "weekly",
      "enabled": false,
      "email-delivery": false,
      "notification-delivery": true,
      "delivery-time": "6",
      "delivery-day": "1",
      "imperatives": null,
      "countries": null,
      "sectors": null,
      "verticals": null,
      "min-market-cap": null,
      "max-market-cap": null,
      "any-entity-watched": null,
      "entity-watched": null,
      "author-followed": null,
      "reading-list-matched": null
    },
    "relationships": {
      "account": {
        "data": {
          "type": "accounts",
          "id": "211"
        }
      }
    }
  }
}
201
{
  "data": {
    "id": "5",
    "type": "alerts",
    "links": {
      "self": "http://test.host/api/v2/alerts/5"
    },
    "attributes": {
      "name": "My first alert",
      "frequency": "weekly",
      "enabled": false,
      "email-delivery": false,
      "notification-delivery": true,
      "delivery-time": "6",
      "delivery-day": "1",
      "imperatives": null,
      "countries": null,
      "sectors": null,
      "verticals": null,
      "min-market-cap": null,
      "max-market-cap": null,
      "any-entity-watched": null,
      "entity-watched": null,
      "author-followed": null,
      "reading-list-matched": null
    },
    "relationships": {
      "account": {
        "links": {
          "self": "http://test.host/api/v2/alerts/5/relationships/account",
          "related": "http://test.host/api/v2/alerts/5/account"
        }
      },
      "filter-preset": {
        "links": {
          "self": "http://test.host/api/v2/alerts/5/relationships/filter-preset",
          "related": "http://test.host/api/v2/alerts/5/filter-preset"
        }
      }
    }
  }
}

Params

Param name Description
data
required

alert information

Validations:

  • Must be a Hash

data[type]
required

Validations: