Skip to main content
POST
Create a comment thread on a document
You’re viewing API version 2026-09, which is deprecated and stops working on October 1, 2027. To see the current version, select 2026-10 in the menu at the top of the sidebar. To move your integration, see Upgrading to 2026-10.

Authorizations

Authorization
string
header
required

Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.

Headers

authorization
string
required

Bearer token for API authentication

Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Path Parameters

id
string
required

Body

application/json

Body

body
string
required

Initial message body for the new thread

Minimum string length: 1
excerpt
string | null

Optional excerpt of the document content the thread refers to

mentions
string[]

User IDs mentioned in the message

visibility
enum<string>

SHARED makes the thread visible to every party on the document; INTERNAL (the default) keeps it to the workspace

Available options:
INTERNAL,
SHARED

Response

200

id
string
required
documentId
string | null
required
status
enum<string>
required
Available options:
OPEN,
RESOLVED
visibility
enum<string>
required
Available options:
INTERNAL,
SHARED
excerpt
string | null
required
createdAt
any
required
updatedAt
any
required
resolvedAt
unknown
required
createdBy
object | null
required
resolvedBy
object | null
required
messages
object[]
required