Create a comment

Method

client.comments.create(args: CreateCommentParameters): Promise<CreateCommentResponse>

Parameters

array

required

An array of rich text objects that represent the content of the comment.

object

The parent of the comment. Required if discussion_id is not provided.

Show properties

string

The ID of the parent page (with or without dashes).

string

The ID of the parent block (with or without dashes).

string

Either "page_id" or "block_id".

string

The ID of the discussion thread to comment on. Required if parent is not provided.

array

An array of files to attach to the comment. Maximum of 3 allowed.

Show properties

string

ID of a FileUpload object that has the status "uploaded".

string

Always "file_upload".

object

Display name for the comment.

Show properties

string

One of: "integration", "user", or "custom".

object

Required when type is "custom".

Show properties

string

The custom display name to use.

string

Bearer token for authentication. If not provided, the client-level auth is used.

Response

Returns a Comment object.

string

Always "comment".

string

The ID of the comment.

object

The parent of the comment (page or block).

string

The ID of the discussion thread this comment belongs to.

array

The rich text content of the comment.

string

The time when the comment was created (ISO 8601 format).

string

The time when the comment was last edited (ISO 8601 format).

object

The user who created the comment.

Example

const comment = await client.comments.create({
  parent: {
    page_id: "page-id-123",
  },
  rich_text: [
    {
      type: "text",
      text: {
        content: "This is a comment",
      },
    },
  ],
})

console.log(comment.id)

Client

Blocks

Pages

Databases

Data Sources

Users

Comments

File Uploads

Search & OAuth

Helpers

Errors

Method

Parameters

Response

Example

​Method

​Parameters

​Response

​Example

Method

Parameters

Response

Example