aboutsummaryrefslogtreecommitdiff
path: root/docs/API/pleroma_api.md
diff options
context:
space:
mode:
authorEgor Kislitsyn <egor@kislitsyn.com>2019-11-14 16:39:45 +0700
committerEgor Kislitsyn <egor@kislitsyn.com>2019-11-14 16:39:45 +0700
commit3c0abfca53751624ebd6ea7174ee880d9e7b29e7 (patch)
treeba16c5af44532a9b76640f1f48651c90d1be8a6f /docs/API/pleroma_api.md
parent768c1a5de172151beb34e6dda13d4fb05e05ed87 (diff)
parent6085c71bd17e2b676e0820bf3fd93f81a1902ac3 (diff)
downloadpleroma-3c0abfca53751624ebd6ea7174ee880d9e7b29e7.tar.gz
Merge remote-tracking branch 'upstream/develop' into feature/move-activity
Diffstat (limited to 'docs/API/pleroma_api.md')
-rw-r--r--docs/API/pleroma_api.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/API/pleroma_api.md b/docs/API/pleroma_api.md
index 6c326dc9b..ad16d027e 100644
--- a/docs/API/pleroma_api.md
+++ b/docs/API/pleroma_api.md
@@ -479,3 +479,35 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa
* `artist`: the artist of the media playing [optional]
* `length`: the length of the media playing [optional]
* Response: the newly created media metadata entity representing the Listen activity
+
+# Emoji Reactions
+
+Emoji reactions work a lot like favourites do. They make it possible to react to a post with a single emoji character.
+
+## `POST /api/v1/pleroma/statuses/:id/react_with_emoji`
+### React to a post with a unicode emoji
+* Method: `POST`
+* Authentication: required
+* Params: `emoji`: A single character unicode emoji
+* Response: JSON, the status.
+
+## `POST /api/v1/pleroma/statuses/:id/unreact_with_emoji`
+### Remove a reaction to a post with a unicode emoji
+* Method: `POST`
+* Authentication: required
+* Params: `emoji`: A single character unicode emoji
+* Response: JSON, the status.
+
+## `GET /api/v1/pleroma/statuses/:id/emoji_reactions_by`
+### Get an object of emoji to account mappings with accounts that reacted to the post
+* Method: `GET`
+* Authentication: optional
+* Params: None
+* Response: JSON, a map of emoji to account list mappings.
+* Example Response:
+```json
+{
+ "😀" => [{"id" => "xyz.."...}, {"id" => "zyx..."}],
+ "🗡" => [{"id" => "abc..."}]
+}
+```