veirox reminder

Manage scheduled reminders

Synopsis

veirox reminder <subcommand> [args] [flags]

Description

Manage scheduled reminders

Subcommands

CommandDescription
veirox reminder createCreate a reminder
veirox reminder info <reminder-id>Show one reminder
veirox reminder listList reminders
veirox reminder rm <reminder-id>Delete a reminder
veirox reminder send-now <reminder-id>Dispatch a reminder immediately
veirox reminder update <reminder-id>Update a reminder

veirox reminder create

Create a reminder

FlagTypeDefaultDescription
--channelstringSlice[]channel name(s) (repeat for multiple)
--descriptionstringfree-form description
--namestringreminder name
--scheduled-atstringRFC3339 scheduled time
veirox reminder create --name 'oncall handoff' --scheduled-at 2026-05-08T09:00:00Z --channel email --channel slack

veirox reminder info <reminder-id>

Show one reminder

veirox reminder info <uuid>

veirox reminder list

List reminders

FlagTypeDefaultDescription
--limitint0page size
--offsetint0pagination offset
--scheduled-datestringfilter by scheduled date (YYYY-MM-DD)
--statusstringfilter by status
veirox reminder list --status pending

veirox reminder rm <reminder-id>

Delete a reminder

FlagTypeDefaultDescription
--yesboolfalseconfirm deletion
veirox reminder rm <uuid> --yes

veirox reminder send-now <reminder-id>

Dispatch a reminder immediately

veirox reminder send-now <uuid>

veirox reminder update <reminder-id>

Update a reminder

FlagTypeDefaultDescription
--channelstringSlice[]new channel(s)
--descriptionstringnew description
--namestringnew name
--scheduled-atstringnew RFC3339 scheduled time
veirox reminder update <uuid> --scheduled-at 2026-05-09T09:00:00Z

Exit codes

CodeMeaning
0Success.
1Generic error (network, API 5xx).
2Validation error (bad flag, missing required arg).
3Unauthenticated — run veirox login or set VEIROX_API_KEY.
4Not found (resource does not exist in this project).
5Permission denied (your role / API key lacks the scope).

See also