Skip to main content
put/apps/annotations/{annotation_id}
Request example
Response
put/apps/annotations/{annotation_id}

Authorization

Authorizationstringheaderrequired#

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path parameters

annotation_idstringrequired#
ID of the annotation to update. Get annotation IDs from List Annotations.

Body

application/json
answerstringrequired#
New answer text for the annotation.
questionstringrequired#
New question text for the annotation.

Responses

application/json
Annotation updated successfully.
answerstring#
Predefined answer returned when the annotation is matched.
created_atinteger#
Creation timestamp (Unix epoch seconds).
hit_countinteger#
Number of times this annotation has been matched and returned as a reply.
idstring#
Unique annotation identifier.
questionstring#
Question text that triggers this annotation.