Comments

Update a comment

Update an existing comment to correct or revise it

patch/posts/{postId}/comments/{commentId}

Path parameters

postIdstring uuid required

Example:123e4567-e89b-12d3-a456-426614174000

Unique identifier of the post

commentIdstring uuid required

Example:987fcdeb-51a2-43d1-9f6b-123456789abc

Unique identifier of the comment

Request body

usernamestring required

Username of the comment author (for validation)

contentstring required

Updated content of the comment

Example request

{
  "username": "jane_smith",
  "content": "Great photo! Where was this taken? The scenery looks amazing!"
}

Response

Comment updated successfully

idstring uuid required

Unique identifier for the comment

postIdstring uuid required

ID of the post this comment belongs to

usernamestring required

Username of the comment author

contentstring required

Content of the comment

createdAtstring date-time required

Timestamp when the comment was created

updatedAtstring date-time required

Timestamp when the comment was last updated

Example response

{
  "id": "987fcdeb-51a2-43d1-9f6b-123456789abc",
  "postId": "123e4567-e89b-12d3-a456-426614174000",
  "username": "jane_smith",
  "content": "Great photo! Where was this taken?",
  "createdAt": "2025-06-01T11:15:00Z",
  "updatedAt": "2025-06-01T11:15:00Z"
}

Changes

Changed in 3 of the 3 revisions of this API.2178

Jul 17, 202641c89b420e8561See the full diff
- ▲
  added the new path request parameter commentId
  new-request-path-parameter
- ▲
  added the new path request parameter postId
  new-request-path-parameter
- ▲
  the response property's maxLength was increased from 500 to 1000 for the response status
  response-property-max-length-increased
- ▲
  the response's property type changed from object to array for status
  response-property-type-changed
- ▲
  the response's property type changed from object to array for status
  response-property-type-changed
- ▲
  the response's property type changed from object to array for status
  response-property-type-changed
- ○
  the request property's maxLength was increased from 500 to 1000
  request-property-max-length-increased
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 30, 20252775bd09f55e436See the full diff
- ▲
  added the new required request property
  new-required-request-property
- ▲
  the request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the response's property type changed from integer to string, and format from no format to uuid for status
  response-property-type-changed
- ▲
  the response's property type changed from integer to string, and format from no format to uuid for status
  response-property-type-changed
- ●
  deleted the path request parameter commentId
  request-parameter-removed
- ●
  deleted the path request parameter postId
  request-parameter-removed
- ●
  the request property's maxLength was set to 500
  request-property-max-length-set
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
May 30, 2025dbaf42ae43111141See the full diff
- ▲
  for the path request parameter commentId, the type changed from string to integer, and format from uuid to no format
  request-parameter-type-changed
- ▲
  for the path request parameter postId, the type changed from string to integer, and format from uuid to no format
  request-parameter-type-changed
- ▲
  the response property's maxLength was unset from 1000 for the response status
  response-property-max-length-unset
- ▲
  the response property's maxLength was unset from 50 for the response status
  response-property-max-length-unset
- ▲
  the response property's minLength was decreased from 1 to 0 for the response status
  response-property-min-length-decreased
- ▲
  the response property's minLength was decreased from 1 to 0 for the response status
  response-property-min-length-decreased
- ▲
  the response's property type changed from string to integer, and format from uuid to no format for status
  response-property-type-changed
- ▲
  the response's property type changed from string to integer, and format from uuid to no format for status
  response-property-type-changed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  the request property's minLength was decreased from 1 to 0
  request-property-min-length-decreased
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history