Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Install the CLI, learn its resource and verb command structure, and read JSON output.
npm install -g @trycourier/cli
PATH.export COURIER_API_KEY="YOUR_COURIER_API_KEY"
courier --version
courier [resource] <command> [flags...]
--help to any command for its flags. Send a notification:
courier send message \
--message.to '{"user_id": "user_123"}' \
--message.template "nt_01kx4h2jdafq8bk9aftxak4b40" \
--message.data '{"commenter": "Sara", "file": "Homepage Redesign"}'
| Resource | Commands |
|---|---|
send | message |
messages | list, retrieve, history, output |
profiles | create, retrieve, replace, patch, delete |
lists | list, update, subscribe, unsubscribe |
notifications | list, create, retrieve-content, publish |
tenants | create, list, retrieve |
user-tenants | add, remove, list |
preferences | retrieve, retrieve-topic, update-topic |
automations | invoke, list |
bulk | create, add-users, run, retrieve |
--format sets the shape: auto (default), json, yaml, pretty, raw, or jsonl for streaming. auto is human-readable in terminals and JSON in pipes.
--transform filters output with GJSON syntax:
courier messages list --format json --transform "results.#.id"
courier messages list --format json --transform "results.#(status=UNDELIVERABLE)"
--api-key overrides COURIER_API_KEY for one command.--base-url points at a custom API URL.--debug prints the HTTP request and response.