Skip to main content
POST
CreateComment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The request for a call to CommentService_CreateComment.

The request for a call to CommentService_CreateComment.

resourceId
string
required

The ID of the resource to attach the comment to.

entityType
enum<string>
default:COMMENT_ENTITY_TYPE_UNSPECIFIED
required

The type of resource a comment is attached to. Designed to be extended over time.

Available options:
COMMENT_ENTITY_TYPE_UNSPECIFIED,
COMMENT_ENTITY_TYPE_CANVAS_CELL_EXECUTION
body
object[]
required

The rich-text body of the new comment.

Response

A successful response.

The response of a call to CommentService_CreateComment.

comment
object

A single comment attached to a resource.