From b6c62a040d34d33374fa844acd9d4219270f5f2f Mon Sep 17 00:00:00 2001 From: Claire Date: Thu, 28 Sep 2023 11:49:54 +0200 Subject: [PATCH] Document exclusive lists (#1310) --- content/en/methods/lists.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/content/en/methods/lists.md b/content/en/methods/lists.md index 12e6a189..c5619d0f 100644 --- a/content/en/methods/lists.md +++ b/content/en/methods/lists.md @@ -50,12 +50,14 @@ Use `id` as a parameter for related API calls. { "id": "12249", "title": "Friends", - "replies_policy": "followed" + "replies_policy": "followed", + "exclusive": false }, { "id": "13585", "title": "test", - "replies_policy": "list" + "replies_policy": "list", + "exclusive": true } ] ``` @@ -106,7 +108,8 @@ The list 12249 exists and is owned by you { "id": "12249", "title": "Friends", - "replies_policy": "followed" + "replies_policy": "followed", + "exclusive": false } ``` @@ -144,7 +147,8 @@ Create a new list. **OAuth:** User token + `write:lists`\ **Version history:**\ 2.1.0 - added\ -3.3.0 - added `replies_policy` +3.3.0 - added `replies_policy`\ +4.2.0 - added `exclusive` #### Request ##### Headers @@ -160,6 +164,9 @@ title replies_policy : String. One of `followed`, `list`, or `none`. Defaults to `list`. +exclusive +: Boolean. Whether members of this list need to get removed from the “Home” feed + #### Response ##### 200: OK @@ -577,4 +584,4 @@ List is not owned by you or does not exist {{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/lists_controller.rb" caption="app/controllers/api/v1/lists_controller.rb" >}} -{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/lists/accounts_controller.rb" caption="app/controllers/api/v1/lists/accounts_controller.rb" >}} \ No newline at end of file +{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/lists/accounts_controller.rb" caption="app/controllers/api/v1/lists/accounts_controller.rb" >}}