✨ Update comment | API Reference

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Update a specific comment by ID.

<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.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path Parameters

idstringRequired

Query Parameters

expand_created_bybooleanOptional

Expand the created_by field

Request

This endpoint expects an object.

annotationintegerOptional

classificationsanyOptional

draftintegerOptional

is_resolvedbooleanOptional

True if the comment is resolved

region_refanyOptional

textstringOptional

Reviewer or annotator comment

Response

object

1	curl -X PATCH http://localhost:8000/api/comments/id/ \
2	-H "Authorization: Token <api_key>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"annotation": 1,
3	"classifications": {
4	"key": "value"
5	},
6	"created_at": "2024-01-15T09:30:00Z",
7	"created_by": 1,
8	"draft": 1,
9	"id": 1,
10	"is_resolved": true,
11	"project": 1,
12	"region_ref": {
13	"key": "value"
14	},
15	"resolved_at": "2024-01-15T09:30:00Z",
16	"state": "state",
17	"task": 1,
18	"text": "text",
19	"updated_at": "2024-01-15T09:30:00Z"
20	}