Skip to main content
POST
Create comment
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

object
required
Information about the user creating the comment.
string
required
UUID of the organisation the comment belongs to.
string
Display name for the user creating the comment.
string
User role, for example admin, member, or guest.
object
required
Information about the site the comment belongs to.
string
required
UUID of the site.
string
required
Site domain, for example example.com.
object
required
Comment payload.
string
required
Comment text content.
string
Priority level: LOW, MEDIUM, or HIGH. Default: MEDIUM.
object
required
Page context for the comment.
string
required
Full URL of the page the comment is on.
string
required
ISO 8601 timestamp in UTC, for example 2026-03-25T11:36:24.000Z.