---
title: "Create User Alert"
method: POST
path: "/user-alerts"
tags: ["Alerts"]
---

# Create User Alert

`POST /user-alerts`

## Request

- Base URL: `https://nzxplorer.co.nz/api/v1`
- URL: `https://nzxplorer.co.nz/api/v1/user-alerts`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in query parameter `api_key`

Create a new alert subscription for the logged-in user. Supports 12 signal types, ticker filtering, severity levels, and email delivery. Maximum 20 alerts per user. Session-authenticated.

## Request body

- object
  - `name` string, required: Human-readable alert name
  - `tickers` string: NZX ticker symbols (empty = all companies)
  - `signal_types` string: Event types to monitor (empty = all types)
  - `min_severity` string: Minimum severity: low, medium, high, critical (default: medium)

## Response `200`

Create User Alert

- Envelope: Standard API response envelope
  - `data` unknown
  - `meta` object
    - `api_version` string
    - `timestamp` string, date-time
    - `format` 'standard' | 'llm' | 'fdc3' | 'toon'
    - `endpoint` string

## Other responses

- `401`: Missing or invalid API key
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/nzxplorer/apis/nzxplorer-api.md) · [All operations](https://skmtc.dev/nzxplorer/apis/nzxplorer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nzxplorer/apis/nzxplorer-api/revisions/f3b95341783a?raw)