Skip to main content
Create a comment or reply

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Body

application/json
entity_type
enum<string>
required
Available options:
invoice,
agreement,
alert,
claim
entity_id
string<uuid>
required
body
string
required
Required string length: 1 - 5000
parent_comment_id
string<uuid>

Response

Created comment.

type
enum<string>
required
Available options:
comment
id
string<uuid>
required
entity_type
enum<string>
required
Available options:
invoice,
agreement,
alert,
claim
entity_id
string<uuid>
required
parent_comment_id
string<uuid> | null
required
body
string
required
author
object
required
occurred_at
string<date-time>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
reply_count
integer
required
Required range: x >= 0