API v1
v1
View as Markdown

Add a reminder

POST /api/v1/vaults/{vault}/contacts/{contact}/reminders

Write a reminder about a contact with a date of its own.

A reminder reading a date on the contact, such as a birthday, is asked for on the contact's page and cannot be made here.

A reminder cannot start before today. One that happens once, dated today, whose hour has already passed, is refused with 422, since there would be nothing left to tell you about.

A refusal names the field it is about: name, starts_on, interval, time or timezone.

Parameters

Sent as JSON. Anything not listed here is ignored.

vault string Required

The vault the contact lives in, named either by the readable name it reports as slug or by its id.

contact string Required

The contact the reminders are about, named either by its slug or by its id. A contact addressed through the wrong vault answers 404.

name string Required

What the reminder says. Up to 255 characters, reduced to plain text.

starts_on string Required

The first date, written as a year, a month and a day.

cadence string Required

One of once, weekly, monthly or yearly.

interval integer Optional

How many of those between two dates, from 1 to 99. Ignored for once.

time string Required

The local hour to be told at, as hours and minutes.

timezone string Optional

The time zone that hour is read in. Your own when left out.

Returns

The reminder object that was added.

data object

The reminder.

data.type string

Always reminder. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.

data.id string

The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.

data.attributes object

Everything the record holds.

data.attributes.name string

What the reminder says when it comes due.

data.attributes.source string

Where its date comes from: manual when somebody wrote the reminder with a date of its own, field_value when it reads a date on the contact, such as a birthday.

data.attributes.starts_on string

The first date of a manual reminder, written as a year, a month and a day. Null for a reminder that reads a date on the contact.

data.attributes.field object

The date on the contact the reminder reads, as an object holding key, how the field is named in an import or an export, and label, what it is called on the contact. Null for a manual reminder.

data.attributes.contact object

The contact the reminder is about.

data.attributes.contact.id uuid

The id of the contact.

data.attributes.contact.name string

The name of the contact.

data.attributes.group object

The group the reminder is about, as an object holding id and name. Always null here, since these reminders are about a contact. A reminder about a group is read from the group reminders endpoints.

data.attributes.cadence string

How often it comes back: once, weekly, monthly or yearly.

data.attributes.interval integer

How many of those between two dates. Every 3 months is monthly with an interval of 3.

data.attributes.time string

The local hour it is told at, on the day itself.

data.attributes.timezone string

The time zone that hour is read in, fixed when the reminder was made.

data.attributes.is_active boolean

Whether it still produces dates. A reminder about an archived contact, or one whose date was cleared, stops and says why.

data.attributes.inactive_reason string

Why it stopped: value_cleared, record_archived, record_deleted or field_removed. Null while it is active.

data.attributes.next_date string

The next date it comes due, or null when nothing is ahead of it.

data.attributes.created_at timestamp

When the reminder was made, as a count of seconds since 1970.

data.links object

Where to find this record.

data.links.self string

The absolute address this record is read from.

Rate limit

Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.

POST
curl https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders \
-X POST \
-H "Authorization: Bearer $MONICA_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Ask how the art school application went",
"starts_on": "2026-10-14",
"cadence": "monthly",
"interval": "1",
"time": "09:00",
"timezone": "America/New_York"
}'
const response = await fetch('https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders', {
method: 'POST',
headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
body: JSON.stringify({
name: 'Ask how the art school application went',
starts_on: '2026-10-14',
cadence: 'monthly',
interval: '1',
time: '09:00',
timezone: 'America/New_York',
}),
})
const data = await response.json()
$response = Http::withToken($token)->post('https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders', [
'name' => 'Ask how the art school application went',
'starts_on' => '2026-10-14',
'cadence' => 'monthly',
'interval' => '1',
'time' => '09:00',
'timezone' => 'America/New_York',
]);
Response 201
{
"data": {
"type": "reminder",
"id": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
"attributes": {
"name": "Ask how the art school application went",
"source": "manual",
"starts_on": "2026-10-14",
"field": null,
"contact": {
"id": "0b6d2f4e-8a13-4c57-9e02-6f3a1d8b7c45",
"name": "Pam Beesly"
},
"group": null,
"cadence": "monthly",
"interval": 1,
"time": "09:00",
"timezone": "America/New_York",
"is_active": true,
"inactive_reason": null,
"next_date": "2026-10-14",
"created_at": 1790380800
},
"links": {
"self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13"
}
}
}

Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.