Rob Zolkos
98b6bdcfb7
* Document avatar removal API endpoint * Document notification settings API endpoints * Document access token list and delete API endpoints * Document join code API endpoints * Fix access token delete URL parameter name in docs
2.3 KiB
2.3 KiB
Notifications
Notifications inform users about events that happened in the account, such as comments, assignments, and card updates.
GET /:account_slug/notifications
Returns a list of notifications for the current user. Unread notifications are returned first, followed by read notifications.
Response:
[
{
"id": "03f5va03bpuvkcjemcxl73ho2",
"read": false,
"read_at": null,
"created_at": "2025-11-19T04:03:58.000Z",
"title": "Plain text mentions",
"body": "Assigned to self",
"creator": {
"id": "03f5v9zjw7pz8717a4no1h8a7",
"name": "David Heinemeier Hansson",
"role": "owner",
"active": true,
"email_address": "david@example.com",
"created_at": "2025-12-05T19:36:35.401Z",
"url": "http://fizzy.localhost:3006/897362094/users/03f5v9zjw7pz8717a4no1h8a7"
},
"card": {
"id": "03f5v9zo9qlcwwpyc0ascnikz",
"title": "Plain text mentions",
"status": "published",
"url": "http://fizzy.localhost:3006/897362094/cards/3"
},
"url": "http://fizzy.localhost:3006/897362094/notifications/03f5va03bpuvkcjemcxl73ho2"
}
]
POST /:account_slug/notifications/:notification_id/reading
Marks a notification as read.
Response:
Returns 204 No Content on success.
DELETE /:account_slug/notifications/:notification_id/reading
Marks a notification as unread.
Response:
Returns 204 No Content on success.
POST /:account_slug/notifications/bulk_reading
Marks all unread notifications as read.
Response:
Returns 204 No Content on success.
GET /:account_slug/notifications/settings
Returns the current user's notification settings.
Response:
{
"bundle_email_frequency": "every_few_hours"
}
Possible values for bundle_email_frequency: never, every_few_hours, daily, weekly.
PUT /:account_slug/notifications/settings
Updates the current user's notification settings.
| Parameter | Type | Required | Description |
|---|---|---|---|
bundle_email_frequency |
string | Yes | How often to bundle notification emails. One of: never, every_few_hours, daily, weekly |
Request:
{
"user_settings": {
"bundle_email_frequency": "daily"
}
}
Response:
Returns 204 No Content on success.