Docs
API ReferenceapicommunityPOST /v1/reports

POST /v1/reports

Service: community · operationId: (none)

Required scopes

(no scope declared — review service config)

Request body

{
  "type": "object",
  "properties": {
    "target_type": {
      "type": "string",
      "enum": [
        "user",
        "post",
        "comment"
      ]
    },
    "target_id": {
      "type": "string",
      "minLength": 1
    },
    "reason": {
      "type": "string",
      "minLength": 1
    },
    "notes": {
      "type": "string"
    }
  },
  "required": [
    "target_type",
    "target_id",
    "reason"
  ]
}

Responses

201 Report submitted

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "reporter_id": {
      "type": "string"
    },
    "target_type": {
      "type": "string"
    },
    "target_id": {
      "type": "string"
    },
    "subject_user_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "reason": {
      "type": "string"
    },
    "notes": {
      "type": [
        "string",
        "null"
      ]
    },
    "resolution": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "dismissed",
        "removed",
        "warn",
        "suspend",
        "ban"
      ]
    },
    "resolved_at": {
      "type": [
        "string",
        "null"
      ]
    },
    "resolved_by_user_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "created_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "reporter_id",
    "target_type",
    "target_id",
    "subject_user_id",
    "reason",
    "notes",
    "resolution",
    "resolved_at",
    "resolved_by_user_id",
    "created_at"
  ]
}

409 Duplicate report within 24 hours

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X POST https://community.platform.loop.health/v1/reports \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Related

POST /v1/posts/{post_id}/unlockOverview