Sign in

Patch API v1 comment by ID

Changed on
patch/api/v1/comment/{id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

idstring required

ID of comment to update

Example:550e8400-e29b-41d4-a716-446655440000

Request body

$schemastring uri

A URL to the JSON Schema for this object.

descriptionstring required

Updated comment text

Example request

{
  "$schema": "https://example.com/schemas/UpdateCommentBody.json",
  "description": "This is a helpful thread"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

descriptionstring required

Content of the comment

has_repliesboolean required

True if this comment has at least one reply

idstring required

ID of comment

is_anonymousboolean required

True if posted as anonymous; frontend can show 'Anonymous' when user_id is omitted

is_likedboolean required

If current user has liked this comment

is_verified_athleteboolean required

If commenter is a verified athlete

like_countinteger required

Number of total likes on comment

parent_comment_idstring required

CommentID this comment is in response to

post_idstring required

PostID of the post this comment is under

Example response

{
  "$schema": "https://example.com/schemas/CommentResponse.json",
  "description": "This is a helpful thread",
  "has_replies": true,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "is_liked": true,
  "is_verified_athlete": true,
  "like_count": 20000,
  "parent_comment_id": "550e8400-e29b-41d4-a716-446655440000",
  "post_id": "550e8400-e29b-41d4-a716-446655440000",
  "user": {
    "bio": "My name is Suli and I'm a pro athlete",
    "division": 1,
    "email": "suli123@email.com",
    "expected_grad_year": 2027,
    "first_name": "Suli",
    "last_name": "Suli",
    "sport": "hockey",
    "username": "suliproathelete",
    "verified_athelete_status": "pending"
  }
}

Changes