Skip to content
This repository was archived by the owner on Jun 27, 2024. It is now read-only.

Latest commit

 

History

History
88 lines (65 loc) · 2.55 KB

File metadata and controls

88 lines (65 loc) · 2.55 KB

Delete Reported Messages of a User

Delete all the reports of messages that belongs to user.

{% hint style="info" %} It requires the manage-moderation-actions permission. {% endhint %}

URL Requires Auth HTTP Method
/api/v1/moderation.user.deleteReportedMessages yes POST

Headers

Argument Example Required Description
X-User-Id myuser-name Required The authenticated user ID.
X-Auth-Token myauth-token Required Auth token.

Body Parameter

Argument Example Required Description
userId 5fRTXMt7DMJbpPJfh Required The id of the user whose reports to delete

Example Payload

{
    "userId":"5fRTXMt7DMJbpPJfh"
}

Example Call

curl --location 'https://writing-demo.dev.rocket.chat/api/v1/moderation.user.deleteReportedMessages' \
--header 'x-auth-token: aEO8Hw3zorBFQtAEYsNPnr67Li9-lY5kX1foen8UiiS' \
--header 'x-user-id: rbAXPnMktTFbNpwtJ' \
--data '{
    "userId":"rbAXPnMktTFbNpwtJ"
}'

Example Result

Success

{
    "success": true
}

Error

Any of the following errors can occur on the endpoint.

  • Authorization: Requires an authentication token for the request to be made.
  • No Permission: Occurs when the authenticated user doesn't have the view-moderation-console permission.

{% tabs %} {% tab title="Authorization" %}

{
    "status": "error",
    "message": "You must be logged in to do this."
}

{% endtab %}

{% tab title="No Permission" %}

{
    "success": false,
    "error": "User does not have the permissions required for this action [error-unauthorized]"
}

{% endtab %} {% endtabs %}

Change Log

Version Description
6.2.0 Added