Skip to main content
PATCH
https://dashboard.laburen.com
/
api
/
annotations
/
{id}
curl --location --request PATCH 'https://dashboard.laburen.com/api/annotations/clxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_KEY>' \
--data-raw '{
    "status": "completed"
}'

{
  "id": "clxxxxxxxxxxxxxxxxx",
  "messageId": "clxxxxxxxxxxxxxxxxx",
  "organizationId": "clxxxxxxxxxxxxxxxxx",
  "comment": "The agent provided incorrect information about pricing",
  "sentiment": "negative",
  "status": "completed",
  "createdById": "clxxxxxxxxxxxxxxxxx",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T11:45:00.000Z",
  "createdBy": {
    "email": "user@example.com"
  },
  "tags": [
    {
      "tag": {
        "id": "clxxxxxxxxxxxxxxxxx",
        "name": "bug"
      }
    }
  ]
}
This endpoint updates the status of an annotation. It supports:
  • Updating annotation status
  • Verifying annotation ownership before updating
  • Returning updated annotation with related data
Authentication is required. You must provide a valid session with an organization ID, and the annotation must belong to your organization.

​
Path

​
id
string
required
The ID of the annotation to update (CUID format).

​
Body

​
Required

​
status
string
required
The new status for the annotation. Valid status values depend on your organization’s configuration.

​
Response

​
id
string
Unique identifier of the annotation (CUID format).
​
messageId
string
ID of the message this annotation refers to.
​
organizationId
string
ID of the organization the annotation belongs to.
​
comment
string
Comment or feedback text for the annotation.
​
sentiment
string
Sentiment of the annotation (e.g., positive, negative, neutral).
​
status
string
Updated status of the annotation.
​
createdById
string
ID of the user who created the annotation.
​
createdAt
string
ISO 8601 timestamp of when the annotation was created.
​
updatedAt
string
ISO 8601 timestamp of when the annotation was last updated.
​
createdBy
object
Information about the user who created the annotation.
​
tags
array
Tags associated with the annotation.

​
Error Responses

Status CodeTypeDescription
400Bad RequestStatus field is required but was not provided.
401UNAUTHORIZEDMissing or invalid authentication session, or annotation does not belong to your organization.
404NOT_FOUNDAnnotation with the specified ID does not exist.
curl --location --request PATCH 'https://dashboard.laburen.com/api/annotations/clxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_KEY>' \
--data-raw '{
    "status": "completed"
}'

{
  "id": "clxxxxxxxxxxxxxxxxx",
  "messageId": "clxxxxxxxxxxxxxxxxx",
  "organizationId": "clxxxxxxxxxxxxxxxxx",
  "comment": "The agent provided incorrect information about pricing",
  "sentiment": "negative",
  "status": "completed",
  "createdById": "clxxxxxxxxxxxxxxxxx",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T11:45:00.000Z",
  "createdBy": {
    "email": "user@example.com"
  },
  "tags": [
    {
      "tag": {
        "id": "clxxxxxxxxxxxxxxxxx",
        "name": "bug"
      }
    }
  ]
}