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"
}'
const apiUrl = 'https://dashboard.laburen.com/api';
const apiKey = '<API_KEY>';
const response = await fetch(`${apiUrl}/annotations/clxxxxxxxxxxxxxxxxx`, {
method: 'PATCH',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${apiKey}`,
},
body: JSON.stringify({
status: 'completed',
}),
});
const data = await response.json();
console.log(data);
import requests
api_url = "https://dashboard.laburen.com/api"
api_key = "<API_KEY>"
response = requests.patch(
f"{api_url}/annotations/clxxxxxxxxxxxxxxxxx",
headers={
"Content-Type": "application/json",
"Authorization": f"Bearer {api_key}",
},
json={
"status": "completed",
},
)
data = response.json()
print(data)
{
"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"
}
}
]
}
Annotations
Annotation - Update
Update the status of an annotation.
PATCH
/
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"
}'
const apiUrl = 'https://dashboard.laburen.com/api';
const apiKey = '<API_KEY>';
const response = await fetch(`${apiUrl}/annotations/clxxxxxxxxxxxxxxxxx`, {
method: 'PATCH',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${apiKey}`,
},
body: JSON.stringify({
status: 'completed',
}),
});
const data = await response.json();
console.log(data);
import requests
api_url = "https://dashboard.laburen.com/api"
api_key = "<API_KEY>"
response = requests.patch(
f"{api_url}/annotations/clxxxxxxxxxxxxxxxxx",
headers={
"Content-Type": "application/json",
"Authorization": f"Bearer {api_key}",
},
json={
"status": "completed",
},
)
data = response.json()
print(data)
{
"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
string
required
The ID of the annotation to update (CUID format).
Body
Required
string
required
The new status for the annotation. Valid status values depend on your organization’s configuration.
Response
string
Unique identifier of the annotation (CUID format).
string
ID of the message this annotation refers to.
string
ID of the organization the annotation belongs to.
string
Comment or feedback text for the annotation.
string
Sentiment of the annotation (e.g.,
positive, negative, neutral).string
Updated status of the annotation.
string
ID of the user who created the annotation.
string
ISO 8601 timestamp of when the annotation was created.
string
ISO 8601 timestamp of when the annotation was last updated.
object
Information about the user who created the annotation.
Hide CreatedBy object
Hide CreatedBy object
string
Email address of the user who created the annotation.
array
Error Responses
| Status Code | Type | Description |
|---|---|---|
| 400 | Bad Request | Status field is required but was not provided. |
| 401 | UNAUTHORIZED | Missing or invalid authentication session, or annotation does not belong to your organization. |
| 404 | NOT_FOUND | Annotation 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"
}'
const apiUrl = 'https://dashboard.laburen.com/api';
const apiKey = '<API_KEY>';
const response = await fetch(`${apiUrl}/annotations/clxxxxxxxxxxxxxxxxx`, {
method: 'PATCH',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${apiKey}`,
},
body: JSON.stringify({
status: 'completed',
}),
});
const data = await response.json();
console.log(data);
import requests
api_url = "https://dashboard.laburen.com/api"
api_key = "<API_KEY>"
response = requests.patch(
f"{api_url}/annotations/clxxxxxxxxxxxxxxxxx",
headers={
"Content-Type": "application/json",
"Authorization": f"Bearer {api_key}",
},
json={
"status": "completed",
},
)
data = response.json()
print(data)
{
"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"
}
}
]
}
Was this page helpful?

