OnyxMetric
Annotations

Update Annotation

Updates an annotation's fields.

PUT /api/sites/:site/annotations/:annotationId

Partial update: only the fields you send change. Admins and owners can edit any annotation on their sites; members can edit only the annotations they created. Changing scope requires an admin or owner role.

Path Parameters

Prop

Type

Request Body

Prop

Type

Example

curl -X PUT "https://app.onyxmetric.com/api/sites/123/annotations/43" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Deployed v2.3.0 (rolled back)", "color": "rose" }'
{ "success": true }