Skip to content

remind_cancel

Gate: ungated · belongs to remind · write

Drop a scheduled reminder. It is a write — it changes state — and it is still ungated, because it can only remove something the assistant itself scheduled, and the worst case is a missed nudge. See the remind kind.

Input

FieldTypeRequiredNotes
idstringyesThe reminder id, as returned by remind or remind_list.

Output

Whether that id was actually pending:

{ "id": "rem-…", "cancelled": true }

cancelled: false means nothing was pending under that id — an unknown id is not an error.

From JavaScript

nocturn.cancelReminder("rem-…");

Notes

A write that is still ungated, which is the exception worth stating rather than hiding. The argument is reach, as everywhere else: the only thing it can remove is something this assistant scheduled through remind, so the worst an injection achieves is a nudge that never arrives. Gating it would put an approval in front of routine housekeeping — the assistant tidying up after itself — and a person asked that often stops reading.

An unknown id answers cancelled: false rather than failing, so a script can cancel optimistically without first checking remind_list.