-
Notifications
You must be signed in to change notification settings - Fork 763
Document chat.ignoreUser API endpoint #1149
Document chat.ignoreUser API endpoint #1149
Conversation
developer-guides/rest-api/README.md
Outdated
@@ -166,6 +166,7 @@ When calling a production Rocket.Chat server, ensure it is running via HTTPS and | |||
| `/api/v1/chat.unStarMessage` | Removes the star on the chat message for the authenticated user. | [Link](chat/unstarmessage/) | | |||
| `/api/v1/chat.update` | Updates the text of the chat message. | [Link](chat/update/) | | |||
| `/api/v1/chat.getMessageReadReceipts` | Retrieves message read receipts. | [Link](chat/getmessagereadreceipts/) | | |||
| `/api/v1/chat.ignoreUser` | Ignores an user from a chat. | [Link](chat/ignoreuser/) | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@thayannevls can you please put this in alphabetic order? Also if you can put the getMessageReadReceipts
in order, because it is unordered too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@thayannevls I think that here, you forgot to put in alphabetic order 😶
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh sorry 😅 now is fixed
| :--- | :--- | :--- | :--- | | ||
| `rid` | `KLTM332QEwWLPJrjRPtcPHimPnLHsusiDF` | Required | The room ID. | | ||
| `userId` | `7aDSXtjMA3KPLxLjt` | Required | The User ID. | | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that is missing the ignore
query parameter, as we can see here.
-H "X-User-Id: aobEdbYhXfu5hkeqG" \ | ||
-H "Content-type:application/json" \ | ||
http://localhost:3000/api/v1/chat.ignoreUser?rid=KLTM332QEwWLPJrjRPtcPHimPnLHsusiDF&userId=7aDSXtjMA3KPLxLjt | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, if you can create an example with ignore
parameter, it would be good. 🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did it! Can you verify if it's correct now?
|
||
| Version | Description | | ||
| :--- | :--- | | ||
| | Added | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The version that it has been add is 0.64.0
, as we can see here.
Add
chat.ignoreUser
endpoint documentation.I couldn't find which version this endpoint was added, can someone help me with this?