One reminder as read from the synchronized profile root.
Actions are already scoped by the reminder's child map. The id is still checked while decoding, so a malformed value cannot escape under a key naming a different reminder.
API reference sections
Schema
StoredReminder
Type object
Shape
| Field | Type | Description |
|---|---|---|
| rulerequired | ReminderRule | |
| deletedrequired | boolean | |
| actionsrequired | array of OccurrenceAction |
{
"rule": {
"id": "00000000-0000-4000-8000-000000000000",
"target": "string",
"revision": "00000000-0000-4000-8000-000000000000",
"status": "enabled",
"schedule": {
"wall": "string",
"type": "floating"
},
"tone_override": "system"
},
"deleted": false,
"actions": [
{
"id": "00000000-0000-4000-8000-000000000000",
"occurrence": "string",
"kind": {
"instant_ms": 0,
"type": "snoozed_until"
}
}
]
}The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.
Used by
GET
Every reminder for ?entity=<canonical entity reference>/v1/profiles/{id}/remindersPOST
Create a reminder at a client-minted id/v1/profiles/{id}/remindersGET
Fetch one reminder/v1/profiles/{id}/reminders/{reminder}PUT
Replace one whole reminder rule revision/v1/profiles/{id}/reminders/{reminder}DELETE
Monotonically delete one reminder/v1/profiles/{id}/reminders/{reminder}GET
Fetch one reminder/v1/profiles/{id}/workspaces/{workspace}/reminders/{reminder}PUT
Replace one whole reminder rule revision/v1/profiles/{id}/workspaces/{workspace}/reminders/{reminder}DELETE
Monotonically delete one reminder/v1/profiles/{id}/workspaces/{workspace}/reminders/{reminder}POST
Pause one reminder as a new atomic revision/v1/profiles/{id}/workspaces/{workspace}/reminders/{reminder}/pausePOST
Resume one reminder as a new atomic revision/v1/profiles/{id}/workspaces/{workspace}/reminders/{reminder}/resumePOST
Append a snooze action/v1/profiles/{id}/workspaces/{workspace}/reminders/{reminder}/snoozePOST
Append a handled action/v1/profiles/{id}/workspaces/{workspace}/reminders/{reminder}/handlePOST
Pause one reminder as a new atomic revision/v1/profiles/{id}/reminders/{reminder}/pausePOST
Resume one reminder as a new atomic revision/v1/profiles/{id}/reminders/{reminder}/resumePOST
Append a snooze action/v1/profiles/{id}/reminders/{reminder}/snoozePOST
Append a handled action/v1/profiles/{id}/reminders/{reminder}/handle
Generated from contract version 1. Last updated .