Update annotation with the PostHog API

Changes an annotation. Only the fields sent change. PostHog does not delete annotations: set deleted to true to hide one, or to false to restore it.

Identifier
posthog_update_annotation

The request

POST https://connect.reportei.com/api/tools/posthog_update_annotation/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "project_id": "<project_id>",
    "annotation_id": 1
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
project_idstringYesId of the project: the project_id of a team in List organizations, or the number after /project/ in the URL of PostHog.
annotation_idintegerYesId of the annotation, from List annotations.
contentstringNoNew text shown on the charts.
date_markerstringNoNew moment of the annotation, for example 2026-10-01T09:00:00Z.
scopestringNoWhere the annotation shows: project, every project of the organization, one dashboard (dashboard_id) or one insight (dashboard_item).Values: project, organization, dashboard, dashboard_item
dashboard_idintegerNoWith scope dashboard, the id of the dashboard, from List dashboards.
dashboard_itemintegerNoWith scope dashboard_item, the numeric id of the insight, from List insights.
deletedbooleanNotrue hides the annotation, which is how PostHog deletes it. false restores it.

Supported connections

Your customer connects their PostHog account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

When connecting, your customer also enters {region}: the address of their account on the app's API.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/posthog_update_annotation. It becomes your agent's tool definition with no conversion.

Other PostHog tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.