Skip to main content
POST
Create a record comment

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

subjectType
string
required

Supported collaboration subject type.

subjectId
integer
required

ID of the accessible collaboration subject.

Body

application/json

Request fields accepted by this operation. Omitted optional properties retain the behavior described above.

body_document
object
required

Comment document version 1. Supports paragraphs containing text, teammate mentions and hard breaks. At most25 distinct mentioned users, all with access to the subject. A comment needs text or an attachment.

idempotency_key
string<uuid>
required

Validation: required|uuid.

Example:

"b2e01bb7-6c5a-4bc6-9ee6-20b5a4295605"

collaboration_attachment_ids
integer[]
Maximum array length: 10
Required range: x >= 1
collaboration_draft_context_id
string<uuid> | null

Validation: nullable|uuid.

Example:

"b2e01bb7-6c5a-4bc6-9ee6-20b5a4295605"

Response

Create a record comment response.

data
object