---
title: "Create Announcement Alert Rule"
method: POST
path: "/announcement-alerts"
tags: ["Market Intelligence"]
---

# Create Announcement Alert Rule

`POST /announcement-alerts`

## Request

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

Create a new announcement alert rule. When matching announcements are published, notifications are delivered via your chosen method. keyword_match_mode controls whether any or all keywords must match.

## Request body

- object
  - `name` string, required: Human-readable rule name
  - `keywords` string, required: Keywords or phrases to match in announcements
  - `tickers` string: NZX tickers to monitor (empty = all)
  - `sectors` string: Sectors to monitor (empty = all)
  - `announcement_types` string: Announcement types to monitor (e.g. FLLYR, GENERAL, SHINTR)
  - `is_active` 'true' | 'false': Whether the rule is active (default: true)

## Response `200`

Create Announcement Alert Rule

- 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)