Flag a message

Flag a CometChat message by message ID with REST API to send it into the moderation review workflow.

POST /messages/{id}/flagged

Flag a message

cURL

curl --request POST \
  --url https://{appId}.api-{region}.cometchat.io/v3/messages/{id}/flagged \
  --header 'Content-Type: application/json' \
  --header 'onBehalfOf: <onbehalfof>' \
  --data '
{
  "reasonId": "<string>",
  "remark": "<string>"
}
'

import requests

url = "https://{appId}.api-{region}.cometchat.io/v3/messages/{id}/flagged"

payload = {
    "reasonId": "<string>",
    "remark": "<string>"
}
headers = {
    "onBehalfOf": "<onbehalfof>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {onBehalfOf: '<onbehalfof>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reasonId: '<string>', remark: '<string>'})
};

fetch('https://{appId}.api-{region}.cometchat.io/v3/messages/{id}/flagged', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{appId}.api-{region}.cometchat.io/v3/messages/{id}/flagged",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reasonId' => '<string>',
    'remark' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "onBehalfOf: <onbehalfof>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{appId}.api-{region}.cometchat.io/v3/messages/{id}/flagged"

	payload := strings.NewReader("{\n  \"reasonId\": \"<string>\",\n  \"remark\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("onBehalfOf", "<onbehalfof>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{appId}.api-{region}.cometchat.io/v3/messages/{id}/flagged")
  .header("onBehalfOf", "<onbehalfof>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reasonId\": \"<string>\",\n  \"remark\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{appId}.api-{region}.cometchat.io/v3/messages/{id}/flagged")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["onBehalfOf"] = '<onbehalfof>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reasonId\": \"<string>\",\n  \"remark\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "data": {}
}

Headers

onBehalfOf · string · required

UID of the user on whose behalf the action is performed.

Path Parameters

id · string · required

Id of the message to be flagged.

Body

application/json

reasonId · string

Unique identifier of the moderation reason used to flag the message.

remark · string

Additional remark or comment about why the message is being flagged.

Response

200 - application/json

Message flagged successfully.

data · object