Skip to main content
POST

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"{{objectId}}"

Body

application/json
content
string
required

Comment body, trimmed before storing. Max 4000 characters.

parentId
string

Optional id of the comment being replied to

Pattern: ^[a-fA-F0-9]{24}$
captchaToken
string

Captcha token. Required when the caller is treated as a guest and the tenant has requireCaptchaForGuestEngagement enabled.

guestId
string

Stable client-generated guest identifier. Used to build the guest fingerprint together with IP and user agent when the caller is unauthenticated.

Response

Created

success
boolean
required
statusCode
integer
required
message
string
required
data
object
required