Skip to Content
annotyDocs
annotyDocs
annoty.appDashboardGetting started

Share with reviewers

Proxy or embed?ProxyEmbedScreenshotsToolbar position

Coding agents

Coding agents (MCP)Send to agent

Integrations

SlackWebhooksDiscordEmailZapiern8n

Reference

GlossaryPlans and billingGet help and send feedback
REST API
List a project's feedback sessions GETCreate a feedback session POSTList the organization's feedback sessions GETGet a feedback session GETUpdate a feedback session PATCHDelete a feedback session DELETEList where a feedback session was opened GET
REST APIFeedback sessions

Delete a feedback session

Update a feedback session PATCH

Only the fields you send change. `proxy` adds or removes the proxy link; a proxy link's slug can't change. Turning a feedback session back on needs room in the plan's `maxFeedbackSessions`, and setting a `password` a proxy link and a plan with `feedbackSessionPassword`. Fails with 409 when a new proxy link's slug is taken. Requires `feedbackSession:update`.

List where a feedback session was opened GET

Every site a widget opened this feedback session on, its proxy link included, most recently opened first. Only pages with the embed link or the embed key count: the embed script does nothing without one. Requires `feedbackSession:read`.

DELETE
/v1/feedback-sessions/{feedbackSessionId}

Deletes its comments too, and disconnects open widgets. Only your organization can reuse its proxy link's slug for the next 60 days. Requires feedbackSession:delete.

Authorization

apiKey
headerAuthorizationBearer <token>

An organization API key from the dashboard (Settings → API keys), e.g. Authorization: Bearer annoty_.... x-api-key: annoty_... also works. While the organization has no subscription or trial, every request with a key except GET /v1/organization fails with 402 SUBSCRIPTION_REQUIRED.

Path Parameters

feedbackSessionId*string

Response Body

Deleted

Example Request
curl -X DELETE 'https://api.annoty.app/v1/feedback-sessions/string'
Example Response
Empty