Report Post API

The report post API allows users to report inappropriate or abusive content in a post to the system administrators. This can help to maintain a safe and respectful environment for all users.

NOTE: You can get list of "report reasons" using Get post report reasons api.

Path Parameters

post_id integer required

post id

Query Parameters

client_auth_token string required

Client API token

Header Parameters

access-token string required

user access token

client string required

client access token

expiry string required

timestamp of token expiry

token-type string required

Default value: Bearer

access token type

uid string required

user uid

application/json

Request Body

report object

abuse string

Report reason

comments string

user comments

Responses

• 200
• 401
• 422
• 500

---

OK

Response Headers

application/json

Schema

Example (from schema)

example-0

example-1

---

Schema

success boolean
message string

{
  "success": true,
  "message": "string"
}

Report Post API (success true) (abuse options: ["Offensive language", "Inappropriate content", "Other"])

{
  "success": true,
  "message": "The post was reported successfully."
}

Report Post API (success false)

{
  "success": false,
  "message": "Some thing went wrong, please try again later!"
}

Unauthorized response, api will respond with this 401 eithr user is not logged in or do not have permission to perform some action. Like creating a post in a room, but user is not member of room.

System will also return 401 if api token is missing or invlaid.

application/json

Schema

Example (from schema)

not logged in

missing or invalid api key

---

Schema

errors string[]
status integer

Default value: 401

success boolean

Default value: false

{
  "errors": [
    "string"
  ],
  "status": 401,
  "success": false
}

{
  "errors": [
    "You need to sign in or sign up before continuing."
  ],
  "success": false
}

{
  "message": "You don't have permission!",
  "status": 401,
  "success": false
}

Unprocessable entity, api will respond with this status if any required params is missing or has invalid value.

application/json

Schema

Example (from schema)

Example 1

---

Schema

success boolean

Default value: false

errors string[]

list of errors

status string

Default value: error

422, unprocessable entity

{
  "success": false,
  "errors": [
    "string"
  ],
  "status": "error"
}

{
  "success": false,
  "errors": [
    "string"
  ],
  "status": "error"
}

Internal server error, api will respond with 500 if something went wrong processing the request.

application/json

Schema

Example (from schema)

---

Schema

success boolean required

Default value: false

message string required

Default value: internal server error

error message

{
  "success": false,
  "message": "internal server error"
}

Loading...