Browse the tools
Reminders
A reminder is a rule telling Monica to tell you about something, on a day and at a time. Each day it falls on is a date you answer.
Tools
List every reminder of a vault, about its contacts and its groups, whatever its date: what it says, whom it is about, how often it comes back and its next date. Use it to answer "what are my reminders". To know what falls in the coming days instead, use list-vault-reminder-occurrences.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
aboutstringoptional -
Only the reminders about contacts, or only those about groups. Both when left out.
One of:
contact,group -
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many reminders a page holds: 25 unless asked, 100 at most.
List the dates of a whole vault that fall in a window: what is overdue, what falls today and what comes in the next 7 days unless days asks for more (up to 365), for every contact, group and record of the vault, as the vault dashboard shows them. An empty list means nothing falls in that window, not that the vault has no reminders: list-vault-reminders lists every reminder whatever its date. Ask kind=birthdays to know whose birthday it is today or soon: it also lists the birthdays nobody asked to be reminded of, with the age being reached when the year of birth is known.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
categorystringoptional -
Only one kind of date: overdue, today, upcoming or history. Overdue, today and upcoming together when left out.
One of:
upcoming,today,overdue,history -
kindstringoptional -
all for every reminder, birthdays for birthdays only. all when left out.
One of:
all,birthdays -
daysintegeroptional - How many days ahead upcoming reaches, from 1 to 365. 7 when left out, as on the vault dashboard.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many dates a page holds: 25 unless asked, 100 at most.
List the reminders about one contact: those written by hand with a date of their own, and those reading a date on the contact, such as a birthday.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
contactstringrequired - The id of the contact, as list-contacts gives it.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many reminders a page holds: 25 unless asked, 100 at most.
Read one reminder about a contact: what it says, where its date comes from, how often it comes back and its next date.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
contactstringrequired - The id of the contact, as list-contacts gives it.
-
reminderstringrequired - The id of the reminder, as list-contact-reminders gives it.
List the dates the reminders about a contact produced, with what the user answered for each: remembered, forgotten, or no answer. A missing answer never means forgotten, and a notification sent or read never means remembered.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
contactstringrequired - The id of the contact, as list-contacts gives it.
-
categorystringoptional -
Only one kind of date: overdue, today, upcoming or history. Every date, newest first, when left out.
One of:
upcoming,today,overdue,history -
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many dates a page holds: 25 unless asked, 100 at most.
Write a reminder about a contact with a date of its own. It is notified on its day, once on each channel the account switched on, and never ahead of it. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
contactstringrequired - The id of the contact, as list-contacts gives it.
-
namestringrequired - What the reminder says.
-
starts_onstringrequired - The first date, as YYYY-MM-DD. It cannot be before today.
-
cadencestringrequired -
How often the reminder comes back.
One of:
once,weekly,monthly,yearly -
intervalintegeroptional - The number of cadence units between two dates, from 1 to 99: cadence weekly with interval 2 means every two weeks.
-
timestringrequired - The local time the reminder is notified at, as HH:MM.
-
timezonestringoptional - The time zone the time is read in. The user's own when left out.
Change what a reminder about a contact says and when it comes back. Dates after today that nobody answered are replaced. Answers already given never change. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
contactstringrequired - The id of the contact, as list-contacts gives it.
-
reminderstringrequired - The id of the reminder, as list-contact-reminders gives it.
-
namestringoptional - What the reminder says.
-
starts_onstringoptional - A new first date, as YYYY-MM-DD, for a reminder written by hand only.
-
cadencestringoptional -
How often the reminder comes back.
One of:
once,weekly,monthly,yearly -
intervalintegeroptional - The number of cadence units between two dates, from 1 to 99: cadence weekly with interval 2 means every two weeks.
-
timestringoptional - The local time the reminder is notified at, as HH:MM.
-
timezonestringoptional - The time zone the time is read in.
Stop a reminder about a contact for good. There is no pause. Dates still waiting for an answer are dropped. Answers already given are kept. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
contactstringrequired - The id of the contact, as list-contacts gives it.
-
reminderstringrequired - The id of the reminder, as list-contact-reminders gives it.
Record, on the user's word, whether they remembered one reminder date or forgot it. remembered is accepted from the date's day, forgotten from the day after. The answer is final and cannot be changed. Only record what the user said. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
contactstringrequired - The id of the contact, as list-contacts gives it.
-
occurrencestringrequired - The id of the date, as list-contact-reminder-occurrences gives it.
-
answerstringrequired -
Whether the user remembered the date or forgot it.
One of:
remembered,forgotten