Skip to main content
POST
/
projects
/
{projectId}
/
reports
Create a report
curl --request POST \
  --url https://api.kansato.com/sdk/whistle/v1/projects/{projectId}/reports \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subject": {
    "type": "user",
    "externalId": "user_789",
    "display": {
      "name": "Jane Doe",
      "username": "janedoe"
    }
  },
  "reporter": {
    "type": "user",
    "externalId": "user_123"
  },
  "target": {
    "contentExternalId": "post_456",
    "contentType": "post"
  },
  "reason": {
    "names": [
      "harassment"
    ]
  },
  "description": "This post contains targeted harassment.",
  "automated": false
}
'
{
  "report": {
    "id": "<string>",
    "projectId": "<string>",
    "status": "OPEN",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.kansato.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key with wh_ prefix. Send as Bearer token: Authorization: Bearer wh_xxxxxxxxxxxx

Path Parameters

​
projectId
string
required

Project UUID

Body

application/json
​
subject
object
required
​
target
object
required
​
reason
object
required

Report reason(s). Use names array or single name string.

​
reporter
object
​
description
string
​
automated
boolean

Whether this report was generated automatically

Response

Report created

​
report
object
required