Browse Community Interaction

beta · api · 0.1.0

Resolve a report and set Comment moderation state

PUT /api/v1/community/comments/{commentId}/reports/{reportId}/decision

Capability Domain: Community Interaction

Authentication

projectCredential (moderation:write)

Scope: moderation:write

Parameters and request body

  • X-Correlation-ID — header, optional
    X-Correlation-ID schema
    {
        "type": "string",
        "format": "uuid"
    }
  • commentId — path, required
    commentId schema
    {
        "type": "string",
        "format": "uuid"
    }
  • reportId — path, required
    reportId schema
    {
        "type": "string",
        "format": "uuid"
    }

Request schema

application/json

application/json request schema
{
    "type": "object",
    "additionalProperties": false,
    "required": [
        "resource_type",
        "resource_id",
        "decision"
    ],
    "properties": {
        "resource_type": {
            "type": "string",
            "maxLength": 120,
            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
        },
        "resource_id": {
            "type": "string",
            "maxLength": 255
        },
        "decision": {
            "type": "string",
            "enum": [
                "no_action",
                "restricted"
            ]
        }
    }
}

application/json request example

application/json request example
{
    "resource_type": "article",
    "resource_id": "article-42",
    "decision": "restricted"
}

Responses and errors

StatusDescription
200Permanent report decision and current Comment moderation state
401Invalid or revoked Project Credential
403Project Credential lacks the required scope
422Request violates the public contract

200 schema

200 response schema
{
    "type": "object",
    "required": [
        "data"
    ],
    "properties": {
        "data": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "report_id",
                "comment_id",
                "status",
                "decision",
                "moderation_state",
                "moderation_reason",
                "decided_at"
            ],
            "properties": {
                "report_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "comment_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "status": {
                    "type": "string",
                    "enum": [
                        "resolved"
                    ]
                },
                "decision": {
                    "type": "string",
                    "enum": [
                        "no_action",
                        "restricted"
                    ]
                },
                "moderation_state": {
                    "type": "string",
                    "enum": [
                        "visible",
                        "restricted"
                    ]
                },
                "moderation_reason": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "enum": [
                        "spam",
                        "harassment",
                        "hate",
                        "violence",
                        "sexual_content",
                        null
                    ]
                },
                "decided_at": {
                    "type": "string",
                    "format": "date-time"
                }
            }
        }
    }
}

401 schema

401 response schema
{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

403 schema

403 response schema
{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

422 schema

422 response schema
{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

200 example

200 response example
{
    "data": {
        "report_id": "53000000-0000-4000-8000-000000000001",
        "comment_id": "51000000-0000-4000-8000-000000000001",
        "status": "resolved",
        "decision": "restricted",
        "moderation_state": "restricted",
        "moderation_reason": "spam",
        "decided_at": "2026-09-09T02:00:00Z"
    }
}

Idempotency

PUT permanently stores the first decision; an identical retry returns it and a different decision is rejected.