# Feature COMMS-51 - Extend API V3 to cover Emoji reactions on work package comments (read, toggle) and extend documentation

Project: Stream Communicator
Status: closed
URL: https://community.openproject.org/work_packages/COMMS-51

## Planning

| Attribute | Value |
| --- | --- |
| Date |  |
| Priority | Medium |
| Target versions | 16.1.0 |
| Sprint |  |
| Backlog bucket |  |
| Votes |  |
| List |  |
| Roadmap |  |
| Relevance |  |

## OPEN POINTS / FEEDBACK

_No work packages_

## Use cases

_No work packages_

## Features and Chunks

| ID | Subject | Type | Status | Assignee | Target versions | Spent time |
| --- | --- | --- | --- | --- | --- | --- |
| COMMS-329 | Extend API V3 to cover Emoji reactions on work package comments (read) and extend documentation | Implementation | closed |  | 16.1.0 |  |
| COMMS-330 | Extend API V3 to cover Emoji reactions on work package comments (toggle) and extend documentation | Implementation | closed |  | 16.1.0 |  |
| COMMS-331 | Extend API V3 to cover Emoji reactions on work package comments (form) and extend documentation | Implementation | rejected |  | 16.1.0 |  |
| COMMS-336 | Update naming and structure of emoji reactions query methods | Implementation | closed |  | 16.1.0 |  |
| COMMS-338 | Restrict emoji reactions API to activity comments | Implementation | closed |  | 16.1.0 |  |

## Bugs and other work packages

_No work packages_

## Technical Details

| Attribute | Value |
| --- | --- |
| Module | API, Modules and project features / Comments and activity |
| Feature Flag |  |
| Requires doc change | No |
| Enterprise plan |  |

## Details

| Attribute | Value |
| --- | --- |
| Pull preview |  |
| Mockups |  |
| Accessibility | No |

## People

| Attribute | Value |
| --- | --- |
| Assignee |  |
| Accountable |  |
| Product manager |  |
| Feature Lead |  |
| Developers | Kabiru Mwenja |
| Designer |  |
| Ordered by |  |
| Signed off by |  |
| Interest by |  |

## Estimates and progress

| Attribute | Value |
| --- | --- |
| PD (min) |  |
| PD (max) |  |
| Work |  |
| Labor costs |  |

## Description

In the context of and follow up on <mention class="mention" data-id="56865" data-type="work_package" data-text="##56865">##56865</mention>

<br>

**As** a client of OpenProject API  
**I want to** be able to read/toggle emoji reactions on a work package comment for a given user

**Acceptance criteria**

  - User with "Add Comments" permission is able to add/remove an emoji reaction

  - User with "Add Comments" permission is able to add/remove an emoji reaction from an internal comment IF they also have "View Internal Comments" permission

  - It is NOT possible to add/remove emoji reactions if the above permissions are missing

**Technical notes**

GET /api/v3/activities/{id}/emoji\_reactions - Emoji Reactions for a single work package comment

GET /api/v3/work\_packages/{id}/activities\_emoji\_reactions - Emoji Reactions for all work package comments, grouped by the activity/comment ID

PATCH /api/v3/activities/{id}/emoji\_reactions - Endpoint that toggles (creates/delete) an emoji reaction for a given user

``` json
{
  "reaction": "thumbs_up"
}
```

**Permissions and visibility considerations**

  - Visible to users with "Add Comments" or "View internal comments" permissions
