Create doc comment

post

https://dovetail.com/api/v1/docs/{doc_id}/comments

Create a comment on a doc.

If no comment thread exists on the doc, one will be created automatically. Pass optional thread_id to reply on an existing page-level or inline thread. The comment is attributed to the authenticated user.

🚧
Permissions
Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or having the correct user role if you're making updates.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

doc_id

string

required

Unique identifier of the doc.

Body Params

Body

body

string

required

length ≤ 10000

The comment content. Interpreted according to body_type (defaults to plain text).

body_type

string

enum

Defaults to text

Format of the body field. Defaults to "text". Use "html" for rich text content.

Allowed:

author_id

string

Workspace user to attribute this comment to. Workspace admins only — useful when importing comments from another tool. The target user must be an active member of the same workspace. If omitted, the comment is attributed to the authenticated user. When an admin sets this field, the author change is recorded in workspace audit logs with the API user as the actor, so overrides remain traceable. Once set, only the target user can edit or delete the comment.

created_at

date-time

ISO 8601 datetime to set as the comment's creation date. Only workspace admins can use this field. If omitted, defaults to the current time. Can only be set at creation time. When an admin sets this field, the timestamp change is recorded in workspace audit logs with the API user as the actor, so overrides remain traceable.

published_at

date-time

ISO 8601 datetime to set as the comment's publication date. This is the timestamp shown in the Dovetail UI for the comment. Only workspace admins can use this field. If omitted, defaults to the current time. Can only be set at creation time. Must be >= created_at and not in the future. When an admin sets this field, the timestamp change is recorded in workspace audit logs with the API user as the actor, so overrides remain traceable.

thread_id

string

Existing comment thread on this doc. When set, the comment is appended to that page-level or inline thread. When omitted, posts on the page-level thread.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

400400

401401

403403

404404

422422

429429

500500