update

Update a Report Resolution

This endpoint allows the user to update a specific report by sending an HTTP PATCH request to the specified URL. The request should include the report ID in the URL and a payload in the raw request body type, with the “isResolved” field indicating whether the report is resolved or not.

Response

The response for this request is a JSON object with the following schema:

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "updatedReport": {
          "type": "object",
          "properties": {
            "_id": {
              "type": "string"
            },
            "review": {
              "type": "string"
            },
            "reporter": {
              "type": "string"
            },
            "reason": {
              "type": "string"
            },
            "isResolved": {
              "type": "boolean"
            },
            "createdAt": {
              "type": "string"
            },
            "updatedAt": {
              "type": "string"
            },
            "__v": {
              "type": "integer"
            }
          }
        }
      }
    },
    "error": {
      "type": "null"
    }
  }
}

PATCH /reports/{reportId}

update

cURL

curl --request PATCH \
  --url http://localhost:8000/v1/reports/{reportId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "isResolved": true
}
'

200

{
  "data": {
    "updatedReport": {
      "__v": 0,
      "_id": "670e386a648069ca43164df6",
      "createdAt": "2024-10-15T09:39:54.100Z",
      "isResolved": true,
      "reason": "Bad review",
      "reporter": "6708d54f9c193b2aeae09b80",
      "review": "670c3a4ede2e2e9ee7d34d0f",
      "updatedAt": "2024-10-15T09:53:11.732Z"
    }
  },
  "error": null
}

Path Parameters

reportId · string · required

Example:

"670e3a38c010adbfe43f5271"

Body

application/json

isResolved · boolean

Example:

true

Response

200

application/json

update - success

data · object

Show child attributes

error · unknown