From 0e400290231667f389dc9f071e38e4fd97d68007 Mon Sep 17 00:00:00 2001
From: Ralf Schmid <rsc@zammad.com>
Date: Wed, 23 Oct 2024 09:33:37 +0200
Subject: [PATCH] Added hint for mentioning/subscribing other users

---
 api/ticket/mentions.rst | 16 ++++++----------
 1 file changed, 6 insertions(+), 10 deletions(-)

diff --git a/api/ticket/mentions.rst b/api/ticket/mentions.rst
index 850b680d..a0653ea5 100644
--- a/api/ticket/mentions.rst
+++ b/api/ticket/mentions.rst
@@ -64,19 +64,15 @@ Response:
 
    # HTTP-Code 201 Created
 
-   {
-     "id":2,
-     "mentionable_type":"Ticket",
-     "mentionable_id":1,
-     "user_id":3,
-     "updated_by_id":3,
-     "created_by_id":3,
-     "created_at":"2021-03-16T08:51:08.985Z",
-     "updated_at":"2021-03-16T08:51:08.985Z"
-   }
+   true
 
 The mention will be created for the user of the current session.
 
+.. hint:: If you want to mention/subscribe other users, you can do so by
+  sending an additional ``X-On-Behalf-Of``-header in your request. You can
+  either provide the user ID or the user email address as value.
+
+
 Delete
 ------