Browse Community Interaction

beta · api · 0.1.0

Replace an author-owned Community Comment with a tombstone

DELETE /api/v1/community/comments/{commentId}

Capability Domain: Community Interaction

Authentication

projectCredential (comments:write)

Scope: comments: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"
    }

Request schema

application/json

application/json request schema
{
    "type": "object",
    "additionalProperties": false,
    "required": [
        "platform_account_id",
        "resource_type",
        "resource_id",
        "idempotency_key"
    ],
    "properties": {
        "platform_account_id": {
            "type": "string",
            "format": "uuid"
        },
        "resource_type": {
            "type": "string",
            "maxLength": 120,
            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$"
        },
        "resource_id": {
            "type": "string",
            "maxLength": 255
        },
        "idempotency_key": {
            "type": "string",
            "maxLength": 180
        }
    }
}

application/json request example

application/json request example
{
    "platform_account_id": "30000000-0000-4000-8000-000000000003",
    "resource_type": "article",
    "resource_id": "article-42",
    "idempotency_key": "article-42-comment-remove-1"
}

Responses and errors

StatusDescription
200Tombstone transition or idempotent replay
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": [
                "comment_id",
                "removed_at",
                "replayed"
            ],
            "properties": {
                "comment_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "removed_at": {
                    "type": "string",
                    "format": "date-time"
                },
                "replayed": {
                    "type": "boolean"
                }
            }
        }
    }
}

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": {
        "comment_id": "51000000-0000-4000-8000-000000000001",
        "removed_at": "2026-09-14T02:00:00Z",
        "replayed": false
    }
}

Idempotency

Repeating the same Project Client idempotency key and input returns the same tombstone. An already removed Comment creates no second transition or event.