Annotations

Update Annotation

Updates an annotation's fields.

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

Partial update: only the fields you send change. Editors and above can edit any annotation on the site, including through a per-site editor grant; members can edit only the annotations they created. Organization-wide annotations, and changing scope, need the editor role or above in the organization, even for the annotation's creator.

Path Parameters

Prop

Type

Request Body

Prop

Type

Example

curl -X PUT "https://app.rybbit.io/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 }