field_notes

Create, read, update, and resolve toolbar field notes — UI feedback a user points at on their own site, surfaced to coding agents over MCP.

patch/api/projects/{project_id}/field_notes/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/field_notes/{id}/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this field note.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

idstring uuid
commentstring

The note the user wrote about the element.

field_note_status'pending' | 'acknowledged' | 'resolved' | 'dismissed'
  • pending - Pending
  • acknowledged - Acknowledged
  • resolved - Resolved
  • dismissed - Dismissed
resolutionstring nullable

Optional note left by the agent when acknowledging, resolving, or dismissing the field note.

urlstring

Full URL of the page the field note was made on.

hoststring

Hostname of the page, used to scope field notes to a site.

pathnamestring nullable

Path portion of the URL.

selectorstring

CSS selector that locates the element on the page.

element_textstring nullable

Visible text of the element, if any.

element_chainstring nullable

Serialized autocapture-style element chain from the element up to the document root.

element_contextobject

Structured element metadata (inferred selectors, attributes, component hints).

screenshot_urlstring nullable

URL of an uploaded screenshot captured with the field_note.

created_atstring date-time
updated_atstring date-time nullable

Response

idstring uuid required
commentstring required

The note the user wrote about the element.

field_note_status'pending' | 'acknowledged' | 'resolved' | 'dismissed'
  • pending - Pending
  • acknowledged - Acknowledged
  • resolved - Resolved
  • dismissed - Dismissed
resolutionstring nullable

Optional note left by the agent when acknowledging, resolving, or dismissing the field note.

urlstring required

Full URL of the page the field note was made on.

hoststring required

Hostname of the page, used to scope field notes to a site.

pathnamestring nullable

Path portion of the URL.

selectorstring required

CSS selector that locates the element on the page.

element_textstring nullable

Visible text of the element, if any.

element_chainstring nullable

Serialized autocapture-style element chain from the element up to the document root.

element_contextobject

Structured element metadata (inferred selectors, attributes, component hints).

screenshot_urlstring nullable

URL of an uploaded screenshot captured with the field_note.

created_atstring date-time required
updated_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.