beta · api · 0.1.0
Create a direct reply to a top-level Community Comment
POST /api/v1/community/comments/{commentId}/replies
Capability Domain: Community Interaction
Authentication
projectCredential (comments:write)
Scope: comments:write
Parameters and request body
-
X-Correlation-ID— header, optionalX-Correlation-ID schema { "type": "string", "format": "uuid" } -
commentId— path, requiredcommentId schema { "type": "string", "format": "uuid" }
Request schema
application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"platform_account_id",
"resource_type",
"resource_id",
"body",
"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
},
"body": {
"type": "string",
"minLength": 1,
"maxLength": 4000
},
"idempotency_key": {
"type": "string",
"maxLength": 180
}
}
}application/json request example
{
"platform_account_id": "30000000-0000-4000-8000-000000000003",
"resource_type": "article",
"resource_id": "article-42",
"body": "A direct reply.",
"idempotency_key": "article-42-reply-1"
}Responses and errors
| Status | Description |
|---|---|
200 | Existing reply returned after an idempotent replay |
201 | Direct reply created |
401 | Invalid or revoked Project Credential |
403 | Project Credential lacks the required scope |
422 | Request violates the public contract |
200 schema
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"platform_account_id",
"resource_type",
"resource_id",
"body",
"revision",
"removed_at",
"moderation_state",
"moderation_reason",
"created_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"parent_comment_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"platform_account_id": {
"type": "string",
"format": "uuid"
},
"resource_type": {
"type": "string"
},
"resource_id": {
"type": "string"
},
"body": {
"type": [
"string",
"null"
]
},
"revision": {
"type": "integer",
"minimum": 1
},
"removed_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"moderation_state": {
"type": "string",
"enum": [
"visible",
"restricted"
]
},
"moderation_reason": {
"type": [
"string",
"null"
],
"enum": [
"spam",
"harassment",
"hate",
"violence",
"sexual_content",
null
]
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}201 schema
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"platform_account_id",
"resource_type",
"resource_id",
"body",
"revision",
"removed_at",
"moderation_state",
"moderation_reason",
"created_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"parent_comment_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"platform_account_id": {
"type": "string",
"format": "uuid"
},
"resource_type": {
"type": "string"
},
"resource_id": {
"type": "string"
},
"body": {
"type": [
"string",
"null"
]
},
"revision": {
"type": "integer",
"minimum": 1
},
"removed_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"moderation_state": {
"type": "string",
"enum": [
"visible",
"restricted"
]
},
"moderation_reason": {
"type": [
"string",
"null"
],
"enum": [
"spam",
"harassment",
"hate",
"violence",
"sexual_content",
null
]
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}401 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
{
"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
{
"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
{
"data": {
"id": "52000000-0000-4000-8000-000000000001",
"parent_comment_id": "51000000-0000-4000-8000-000000000001",
"platform_account_id": "30000000-0000-4000-8000-000000000003",
"resource_type": "article",
"resource_id": "article-42",
"body": "A direct reply.",
"created_at": "2026-09-05T02:00:00Z"
}
}201 example
{
"data": {
"id": "52000000-0000-4000-8000-000000000001",
"parent_comment_id": "51000000-0000-4000-8000-000000000001",
"platform_account_id": "30000000-0000-4000-8000-000000000003",
"resource_type": "article",
"resource_id": "article-42",
"body": "A direct reply.",
"created_at": "2026-09-05T02:00:00Z"
}
}Idempotency
Repeating the same Project Client idempotency key, parent and input returns the existing reply; changed input is rejected.