Skip to main content
POST
/
comments
Create comment
curl --request POST \
  --url https://api.surefeedback.com/api/v1/comments \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "site_id": "<string>",
  "page_url": "<string>",
  "content": "<string>",
  "priority": "<string>",
  "x_position": 123,
  "y_position": 123,
  "screenshot": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "990e8400-e29b-41d4-a716-446655440004",
    "content": "The header looks misaligned on mobile.",
    "status": "open",
    "priority": "high",
    "page_url": "https://example.com/home",
    "created_at": "2026-03-02T12:00:00Z"
  }
}
Creates a new comment associated with a page on a site. Typically used by the widget, but can also be called from server-side integrations.
Requires authentication. The user must have access to the site.

​
Request body

​
site_id
string
required
UUID of the site.
​
page_url
string
required
Full URL of the page the comment is on.
​
content
string
required
Comment text content.
​
priority
string
Priority level: low, medium, or high. Default: medium.
​
x_position
number
Horizontal position of the pin as a percentage (0–100).
​
y_position
number
Vertical position of the pin as a percentage (0–100).
​
screenshot
string
Base64-encoded screenshot or URL.
{
  "success": true,
  "data": {
    "id": "990e8400-e29b-41d4-a716-446655440004",
    "content": "The header looks misaligned on mobile.",
    "status": "open",
    "priority": "high",
    "page_url": "https://example.com/home",
    "created_at": "2026-03-02T12:00:00Z"
  }
}