API reference · Reminders
rem_Reminders
Per-event reminders with snooze support and travel-adjusted firing.
Endpoints
POST
/v1/events/{id}/reminders
Schedule a reminder
idempotent
GET
/v1/events/{id}/reminders
List reminders
DELETE
/v1/reminders/{id}
Cancel a reminder
POST
/v1/reminders/{id}/snooze
Snooze
Schedule a reminder for an event
HTTP
POST /v1/events/{id}/reminders| Field | Type | Description |
|---|---|---|
| offset_minutes | integer | Minutes before event start. Allowed: 5, 15, 30, 60, 120, 1440 (1 day), 10080 (1 week). |
| custom_time | datetime? | Explicit time, in lieu of offset_minutes. |
| message | string? | Custom message. |
List reminders for an event
HTTP
GET /v1/events/{id}/remindersCancel a reminder
HTTP
DELETE /v1/reminders/{id}Snooze a reminder
HTTP
POST /v1/reminders/{id}/snoozeJSON
{ "snooze_minutes": 5 }Allowed snooze minutes: 1, 3, 5, 15.
Object shape
| Field | Type | Description | |
|---|---|---|---|
| id | string | Prefixed rem_. | |
| event_id | string | Associated event. | |
| reminder_type | string | before_event or custom_time. | |
| offset_minutes | integer? | Minutes before event start (when type=before_event). | |
| custom_time | datetime? | Explicit reminder time. | |
| scheduled_at | datetime | Resolved fire time. | |
| status | string | scheduled, sent, dismissed. | |
| sent_at | datetime? | Delivery time. | |
| message | string? | User note attached to the reminder. |