Reminder settings
Reminder/notification settings
INFO
Every response arrives in the shared envelope — code, message, messages, status_code, time — with the payload in data. The tables below describe what is inside data.
GET /reminder-settings/get
Get the tenant's reminder settings (created with defaults on first access).
Request body
No request body.
Response
| Field | Type | Description |
|---|---|---|
_id | string | MongoDB ObjectId |
account_id | string | Tenant identifier (immutable) |
minute | integer | Reminder lead time in minutes (>= 0) |
is_deleted | boolean | |
created_at | string (date-time) | |
updated_at | string (date-time) |
json
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": {
"_id": "string",
"account_id": "string",
"minute": 0,
"is_deleted": false,
"created_at": "2025-05-01T12:00:00Z",
"updated_at": "2025-05-01T12:00:00Z"
},
"time": "2025-05-01T12:00:00Z"
}PUT /reminder-settings/set
Update the tenant's reminder settings (partial patch). Only minute is settable.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
minute | integer | No | Reminder lead time in minutes (>= 0) |
json
{
"minute": 0
}Response
Same response shape as GET /reminder-settings/get.
This page is generated from the OpenAPI spec.