Sign in
Comments

✨ Update comment

<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Update a specific comment by ID.
patch/api/comments/{id}/

Path parameters

idinteger required

A unique integer value identifying this comment.

Query parameters

expand_created_byboolean

Expand the created_by field

Request body

annotationinteger nullable
{"stackTrail":"components:schemas:PatchedCommentRequest:properties:classifications","oasType":"schema","type":"unknown","description":"Classifications applied by a reviewer or annotator","nullable":true}
draftinteger nullable
is_resolvedboolean

True if the comment is resolved

{"stackTrail":"components:schemas:PatchedCommentRequest:properties:region_ref","oasType":"schema","type":"unknown","description":"Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name.","nullable":true}
textstring nullable

Reviewer or annotator comment

Response

OR

Changes

Changed in 3 of the 97 revisions of this API.114

  • 037e8b19fbfd4See the full diff
    • ○

      added the required property oneOf[CommentSerializerWithExpandedUser]/created_by/org_membership/items/flex to the response with the 200 status

      response-required-property-added

    • ○

      added the required property oneOf[CommentSerializerWithExpandedUser]/created_by/org_membership/items/user_type to the response with the 200 status

      response-required-property-added

    • ○

      added the required property oneOf[CommentSerializerWithExpandedUser]/created_by/organization_membership/allOf[OrganizationMembership]/flex to the response with the 200 status

      response-required-property-added

    • ○

      added the required property oneOf[CommentSerializerWithExpandedUser]/created_by/organization_membership/allOf[OrganizationMembership]/user_type to the response with the 200 status

      response-required-property-added

  • b5f055b9d45b10See the full diff
    • ▲

      the response property oneOf[CommentSerializerWithExpandedUser]/created_by/avatar became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property oneOf[CommentSerializerWithExpandedUser]/created_by/lse_fields/allOf[LseFields]/invite_expired became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property oneOf[CommentSerializerWithExpandedUser]/created_by/lse_fields/allOf[LseFields]/invite_expired_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property oneOf[CommentSerializerWithExpandedUser]/created_by/pause became nullable for the status 200

      response-property-became-nullable

    • ▲

      the oneOf[CommentSerializerWithExpandedUser]/created_by/active_organization_meta response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • ▲

      the oneOf[CommentSerializerWithExpandedUser]/created_by/lse_fields/allOf[LseFields]/email_notification_settings response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • ▲

      the oneOf[CommentSerializerWithExpandedUser]/created_by/lse_fields/allOf[LseFields]/invite_expired response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

    • ▲

      the oneOf[CommentSerializerWithExpandedUser]/created_by/org_membership/items/active response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

    • ▲

      the oneOf[CommentSerializerWithExpandedUser]/created_by/organization_membership/allOf[OrganizationMembership]/active response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

    • ▲

      the oneOf[CommentSerializerWithExpandedUser]/created_by/pause response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

  • c2893748a8d31See the full diff
    • ▲

      for the path request parameter id, the type/format was changed from string/ to integer/

      request-parameter-type-changed

Of the 97 revisions, 1 has no diff computed.