Skip to content

Commit 46e78e4

Browse files
authored
docs: Document the ability to set "starred" using the PUT /v1/entries endpoint
1 parent fbb25f2 commit 46e78e4

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

content/docs/api.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Table of Contents:
3535
- [Get Category Entries](#endpoint-get-category-entries)
3636
- [Get Entries](#endpoint-get-entries)
3737
- [Get Entry IDs](#endpoint-get-entry-ids)
38-
- [Update Entries status](#endpoint-update-entries)
38+
- [Update Entries status or starred](#endpoint-update-entries)
3939
- [Toggle Entry Bookmark](#endpoint-toggle-bookmark)
4040
- [Get Enclosure](#endpoint-get-enclosure)
4141
- [Update Enclosure](#endpoint-update-enclosure)
@@ -1149,10 +1149,15 @@ Request:
11491149

11501150
{
11511151
"entry_ids": [1234, 4567],
1152-
"status": "read"
1152+
"status": "read",
1153+
"starred": true
11531154
}
11541155

1155-
Returns a `204` status code for success.
1156+
The client must send "entry_ids", and either "status", "starred", or both. Returns a `204` status code for success.
1157+
1158+
<div class="info">
1159+
The ability to send "starred" is available since Miniflux v2.3.2.
1160+
</div>
11561161

11571162
<h3 id="endpoint-toggle-bookmark">Toggle Entry Bookmark <a class="anchor" href="#endpoint-toggle-bookmark" title="Permalink">¶</a></h3>
11581163

0 commit comments

Comments
 (0)