aboutsummaryrefslogtreecommitdiff
path: root/docs/API
diff options
context:
space:
mode:
authorHaelwenn <contact+git.pleroma.social@hacktivis.me>2020-07-08 03:25:30 +0000
committerHaelwenn <contact+git.pleroma.social@hacktivis.me>2020-07-08 03:25:30 +0000
commita8447c3803b9d618f8c1d1910698c8cca6e908e4 (patch)
tree131a5dca1ff1779389515078fa09ce01ab87c12e /docs/API
parentdb13acf24261a3f3cb1a747a722df1f86a768955 (diff)
parent92e6801c179080e833575226fdf291d9393286c5 (diff)
downloadpleroma-a8447c3803b9d618f8c1d1910698c8cca6e908e4.tar.gz
Merge branch '1918-avatar-background-header-reset-2' into 'develop'
Resolve "Better support for resetting avatar/header/background" Closes #1918 See merge request pleroma/pleroma!2729
Diffstat (limited to 'docs/API')
-rw-r--r--docs/API/differences_in_mastoapi_responses.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/API/differences_in_mastoapi_responses.md b/docs/API/differences_in_mastoapi_responses.md
index d2455d5d7..29141ed0c 100644
--- a/docs/API/differences_in_mastoapi_responses.md
+++ b/docs/API/differences_in_mastoapi_responses.md
@@ -182,10 +182,12 @@ Additional parameters can be added to the JSON body/Form data:
- `pleroma_settings_store` - Opaque user settings to be saved on the backend.
- `skip_thread_containment` - if true, skip filtering out broken threads
- `allow_following_move` - if true, allows automatically follow moved following accounts
-- `pleroma_background_image` - sets the background image of the user.
+- `pleroma_background_image` - sets the background image of the user. Can be set to "" (an empty string) to reset.
- `discoverable` - if true, discovery of this account in search results and other services is allowed.
- `actor_type` - the type of this account.
+All images (avatar, banner and background) can be reset to the default by sending an empty string ("") instead of a file.
+
### Pleroma Settings Store
Pleroma has mechanism that allows frontends to save blobs of json for each user on the backend. This can be used to save frontend-specific settings for a user that the backend does not need to know about.