1
0
mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00

Document exclusive lists (#1310)

This commit is contained in:
Claire 2023-09-28 11:49:54 +02:00 committed by GitHub
parent eda06de4fe
commit b6c62a040d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -50,12 +50,14 @@ Use `id` as a parameter for related API calls.
{ {
"id": "12249", "id": "12249",
"title": "Friends", "title": "Friends",
"replies_policy": "followed" "replies_policy": "followed",
"exclusive": false
}, },
{ {
"id": "13585", "id": "13585",
"title": "test", "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", "id": "12249",
"title": "Friends", "title": "Friends",
"replies_policy": "followed" "replies_policy": "followed",
"exclusive": false
} }
``` ```
@ -144,7 +147,8 @@ Create a new list.
**OAuth:** User token + `write:lists`\ **OAuth:** User token + `write:lists`\
**Version history:**\ **Version history:**\
2.1.0 - added\ 2.1.0 - added\
3.3.0 - added `replies_policy` 3.3.0 - added `replies_policy`\
4.2.0 - added `exclusive`
#### Request #### Request
##### Headers ##### Headers
@ -160,6 +164,9 @@ title
replies_policy replies_policy
: String. One of `followed`, `list`, or `none`. Defaults to `list`. : 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 #### Response
##### 200: OK ##### 200: OK