Skip to main content
POST
/
comments
/
create
Create comment
curl --request POST \
  --url https://api.surefeedback.com/api/v1/comments/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "user": {},
  "user.org_id": "<string>",
  "user.name": "<string>",
  "user.role": "<string>",
  "site": {},
  "site.site_id": "<string>",
  "site.domain": "<string>",
  "comment": {},
  "comment.content": "<string>",
  "comment.priority": "<string>",
  "context": {},
  "context.page_url": "<string>",
  "context.timestamp": "<string>"
}
'
{
  "success": true,
  "message": "Comment created successfully",
  "data": {
    "comment": {
      "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

​
user
object
required
Information about the user creating the comment.
​
user.org_id
string
required
UUID of the organisation the comment belongs to.
​
user.name
string
Display name for the user creating the comment.
​
user.role
string
User role, for example admin, member, or guest.
​
site
object
required
Information about the site the comment belongs to.
​
site.site_id
string
required
UUID of the site.
​
site.domain
string
required
Site domain, for example example.com.
​
comment
object
required
Comment payload.
​
comment.content
string
required
Comment text content.
​
comment.priority
string
Priority level: LOW, MEDIUM, or HIGH. Default: MEDIUM.
​
context
object
required
Page context for the comment.
​
context.page_url
string
required
Full URL of the page the comment is on.
​
context.timestamp
string
required
ISO 8601 timestamp in UTC, for example 2026-03-25T11:36:24.000Z.
{
  "success": true,
  "message": "Comment created successfully",
  "data": {
    "comment": {
      "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"
    }
  }
}