Reactions

Use the addReaction and removeReaction mutations to toggle an emoji reaction on a comment. Both take the same shape — a targetType, the targetId of the thing being reacted to, and the emoji itself — and both return the target’s complete reaction set as [ReactionGroup!]!. Each ReactionGroup rolls up one emoji: how many people used it, who they are, and whether the calling user is one of them.

Reactions are stored one row per user, emoji, and target, so a user contributes at most one of any given emoji to a target. Both mutations are idempotent: adding a reaction you already have, or removing one you never had, succeeds and returns the current set unchanged.

The targetType is a ReactionTargetType enum with two values — COMMENT and CHAT_MESSAGE. This page covers reacting to comments. The CHAT_MESSAGE target works identically but applies to chat messages, documented with the rest of the chat API. Comments are Comment objects in the API; see Comments overview for how a comment attaches to a record, discussion, or status update.

Request

Add a thumbs-up to a comment. Pass the comment’s id as targetId and an emoji string. The mutation returns the comment’s full reaction set after the change.

mutation AddReaction {
  addReaction(input: { targetType: COMMENT, targetId: "comment_123", emoji: "👍" }) {
    emoji
    count
    reactedByMe
    users {
      id
      fullName
    }
  }
}

Remove it again with the matching mutation — same input shape:

mutation RemoveReaction {
  removeReaction(input: { targetType: COMMENT, targetId: "comment_123", emoji: "👍" }) {
    emoji
    count
    reactedByMe
  }
}

Parameters

AddReactionInput

RemoveReactionInput

Identical to AddReactionInput. The emoji is matched against the calling user’s existing reaction on the target.

ReactionTargetType

Response

Both mutations return the target’s reaction set: one ReactionGroup per distinct emoji currently on the target, ordered by when each emoji first appeared. After adding 👍 to a comment that already had two 🎉 reactions:

{
  "data": {
    "addReaction": [
      {
        "emoji": "🎉",
        "count": 2,
        "reactedByMe": false,
        "users": [
          { "id": "clm4n8qwx000008l0g4oxdqn7", "fullName": "Ada Lovelace" },
          { "id": "clm4n8qwx000108l0h2pzabc9", "fullName": "Alan Turing" }
        ]
      },
      {
        "emoji": "👍",
        "count": 1,
        "reactedByMe": true,
        "users": [{ "id": "clm4n8qwx000208l0k7rtd5e3", "fullName": "Grace Hopper" }]
      }
    ]
  }
}

Removing the last reaction of an emoji drops its group from the array entirely. A target with no reactions returns [].

ReactionGroup

Reading reactions without changing them

addReaction and removeReaction are the only operations that mutate reactions — there’s no separate “set” or “clear” mutation. To read a comment’s reactions without modifying them, select the reactions field on the Comment itself; it returns the same [ReactionGroup!]!. Fetch comments with the commentList query:

query CommentReactions {
  commentList(category: TODO, categoryId: "todo_123") {
    comments {
      id
      reactions {
        emoji
        count
        reactedByMe
      }
    }
  }
}

Errors

Permissions

For a comment attached to a record, both mutations require comment-level access to that record — the same access required to post a comment there. Callers with view-only access are denied with FORBIDDEN.

Comments attached to a discussion or status update are not currently access-checked beyond authentication, so any authenticated member of the organization can react to them. Do not rely on a per-thread guarantee for those targets.

Related

• Comments overview — how a Comment attaches to a record, discussion, or status update.
• Create, edit & delete comments — the comment write lifecycle.
• Query comments — fetch comments (and their reactions) for any target.